KNIRV GATEWAY

The Unified Web Portal and API Gateway for the KNIRV Decentralized Trusted Execution Network

  

Table of Contents

- Overview - Key Features - Architecture - Quick Start - API Gateway Functionality - Server-Sent Events (SSE) - Development - Environment Variables - Portal Sections - Deployment - Contributing - Testing - Support - License - Acknowledgments - Changelog - Social Media Sharing Guide

Overview

KNIRVGATEWAY serves as the primary web portal and API gateway for the KNIRV D-TEN (Decentralized Trusted Execution Network). It combines a modern, responsive website with serverless API gateway functionality, providing a unified entry point for users, developers, and services within the KNIRV ecosystem. Migrated from a Go-based WebSocket gateway (KNIRVGATEWAY), it now utilizes Netlify Functions and Server-Sent Events (SSE) for improved performance and browser compatibility.

Key Features

- 🌐 Modern Web Portal: Responsive website showcasing KNIRV D-TEN capabilities - 🚀 Serverless API Gateway: Netlify Functions-based gateway with SSE support - 🧪 KNIRVTESTNET Integration: Live testnet frontend with AWS backend connectivity - 👨‍💻 Developer Portal: Comprehensive documentation and tools for KNIRV developers - 📚 Documentation Hub: Integrated documentation with Docsify - 🔄 Real-time Updates: Server-Sent Events (SSE) for live data streaming - 🔐 Authentication: Secure API access and user management (JWT-based, configurable) - 📊 Health Monitoring: Real-time service health and metrics - 🎨 Glass Morphism UI: Modern design with balanced blue/purple color scheme - 🗣️ Social Media Optimization: Platform-specific content and meta tags for enhanced sharing.

Architecture

Web Portal Components

` KNIRVGATEWAY/ ├── index.html # Main website entry point ├── assets/ # Static assets (CSS, JS, images) ├── images/ # Website images and branding ├── agent-developer-portal/ # Developer documentation and tools ├── documentation/ # Docsify-based documentation ├── knirvtestnet/ # KNIRVTESTNET frontend integration │ ├── index.html # Testnet dashboard │ ├── testnet-config.js # Testnet API configuration │ └── README.md # Testnet documentation └── logo/ # KNIRV branding components `

API Gateway Components

` netlify/functions/ ├── gateway-sse.js # Main API gateway with SSE support └── health-monitor.js # Service health monitoring `

Configuration

` ├── netlify.toml # Netlify deployment configuration ├── package.json # Node.js dependencies and scripts └── _redirects # URL routing rules `

Quick Start

Prerequisites

- Node.js 18.0.0 or higher - npm or yarn package manager - Netlify CLI (for local development)

Installation

1. Clone and navigate to the directory: `bash cd KNIRVGATEWAY `

2. Install dependencies: `bash npm install `

3. Start local development server: `bash npm run dev `

4. Access the portal: - Website: http://localhost:8888 - API Gateway: http://localhost:8888/gateway/* - Health Monitor: http://localhost:8888/health-monitor/*

Build and Deploy

1. Build for production: `bash npm run build `

2. Deploy to Netlify: `bash npm run deploy `

API Gateway Functionality

Endpoints

Gateway Management

Health Monitoring

Authentication

Service Proxy

Server-Sent Events (SSE)

The gateway supports real-time updates via SSE:

`javascript // Connect to gateway events const eventSource = new EventSource('/gateway/events'); eventSource.onmessage = function(event) { const data = JSON.parse(event.data); console.log('Gateway update:', data); };

// Connect to health monitoring const healthSource = new EventSource('/health-monitor/events'); healthSource.onmessage = function(event) { const health = JSON.parse(event.data); console.log('Health update:', health); }; `

Development

Available Scripts

- npm run dev - Start development server with hot reload - npm run build - Build for production - npm run deploy - Deploy to Netlify - npm run functions:test - Test gateway functions - npm run validate - Validate Netlify Functions

Local Development

1. Start the gateway: `bash npm run dev `

2. Test API endpoints: `bash curl http://localhost:8888/gateway/health `

3. Test SSE functionality: `bash curl -N -H "Accept: text/event-stream" http://localhost:8888/gateway/events `

Environment Variables

Configure these environment variables for production:

`bash

Service URLs

Authentication

Monitoring

Portal Sections

Main Website

Agent Developer Portal

Documentation Hub

Deployment

Netlify Configuration

The project is configured for Netlify deployment with:

- Build Command: npm run build - Publish Directory: . (root) - Functions Directory: netlify/functions - Node.js Version: 18.x

Production Checklist

- [ ] Environment variables configured - [ ] SSL certificate installed - [ ] Custom domain configured - [ ] CDN caching optimized - [ ] Security headers configured - [ ] Performance monitoring enabled

Contributing

1. Fork the repository 2. Create a feature branch: git checkout -b feature/new-feature 3. Make your changes 4. Test thoroughly: npm run validate 5. Commit your changes: git commit -am 'Add new feature' 6. Push to the branch: git push origin feature/new-feature 7. Submit a pull request

Testing

Manual Testing

`bash

Test gateway functionality

Test complete system

Integration Testing

`bash

Run integration tests

Support

- Documentation: docs.knirv.network - Developer Portal: portal.knirv.network - Community: community.knirv.network - Issues: GitHub Issues

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

- Built with Netlify Functions - Documentation powered by Docsify - UI components from Bootstrap - Icons from Feather Icons

---

KNIRV Gateway - Powering the future of decentralized AI and trusted execution networks.

For more information about the KNIRV ecosystem, visit knirv.network.

Changelog

All notable changes to the KNIRV Gateway project will be documented in this section. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.0.0] - 2025-01-08

Added

Gateway Functions

API Endpoints

Infrastructure

Documentation

Development Tools

[0.9.0] - 2025-01-07 (Pre-release)

Added

Changed

Removed

Migration History

From KNIRVGATEWAY to KNIRVGATEWAY

Architecture Evolution

Technical Debt Addressed

Build Configuration

Security

Performance

Maintainability

Future Roadmap

Planned Features

Technical Improvements

Social Media Sharing Guide

This guide explains the comprehensive social media sharing optimization implemented for the KNIRV D-TEN website. Each platform has been customized with platform-specific content, images, and metadata to maximize engagement and reach.

Platform-Specific Optimizations

🔵 Facebook

🐦 Twitter/X

#AI #Blockchain #DeFi #Web3 `

💼 LinkedIn

📺 YouTube

🔥 Features: • 12 sovereign layers working in harmony • Self-healing AI network • Verifiable execution environments • NRN token economics • Collective intelligence

Subscribe for updates on the future of AI! 🚀 `

🐙 GitHub

Key Features