# ⚔️ Raid Guild Proposal <> POKT OPEN PRIORITY: Gateway Demo ⚔️

> Building a User-facing Demo Gateway on top of the Nodies Gateway Kit

## Scope of Work
We are thrilled to present our comprehensive proposal for developing a state-of-the-art Software as a Service (SaaS) web portal that leverages the Gateway Kit as its robust backend. Our goal is to exceed expectations by incorporating essential features and considering some nice-to-have enhancements, resulting in a scalable portal that aligns perfectly with the needs of modern self-service SaaS platforms. We are committed to delivering an agile development process with active involvement from PNF and the Pocket community.

## POKT POP- Gateway SaaS Kit

### Detailed Modules Overview

#### 1. Project Website & Documentation
- **A. Public-Facing Website Development**
- **Framework**: Utilize React.js for a responsive, dynamic project website.
- **B. Comprehensive Documentation**
- **Tool**: Employ Docusaurus or similar for user-friendly documentation.
- **Content**: Include thorough API docs and user manuals.

#### 2. User Access Module
- **A. User Authentication System**
- **Authentication**: Implement OAuth2.0 or JWT for secure login.
- **User Management**: Full CRUD operations for user profiles.
- **B. App/Endpoint Management System**
- **App Settings**: Intuitive UI for configuration settings.
- **API Key Management**: Robust system for key generation and security.
- **Usage Reporting**: Detailed analytics and log dashboard for monitoring.

#### 3. Drop-in Payment Module
- **A. User-Payment Plan Setup**
- **Payment Integration**: Pay as you go crypto payments in multiple tokens.
- **Subscription Tiers**: Multiple tiers to cater to different user needs.
- **B. Invoicing & Reporting**
- **Usage Notifications**: Automated alerts for usage and billing.

#### 4. Gateway Admin Module - Frontend
- **A. Gateway Health & Monitoring**
- **Monitoring**: Real-time tracking and management of app stakes, utilizing Gateway Kit Prometheus metrics.
- **Visualization**: Dynamic, visual representation of stats and health indicators.
- **B. User Access & Monitoring**
- **Admin Panel**: Comprehensive user access management interface.
- **Audit Trails**: Detailed logging and auditing for security and compliance.

#### 5. Gateway Proxy/Backend Setup
- **A. Request Relaying via Gateway Kit**
- **Load Balancing**: Implement effective load distribution and routing.
- **B. Backend Tasks**
- **Data Processing**: Efficient handling and processing of backend data.
- **Caching Setup**: Implement caching for enhanced performance and speed.

## Stack Details

### Frontend
- **Framework**: Next.js
- Utilizes React.js, enabling server-side rendering and static site generation.
- Improved SEO, performance, easy routing, and Node.js integration.

### Backend
- **Framework**: NestJS with Prisma ORM
- NestJS offers modular architecture, maintainable and scalable code.
- TypeScript support for reliability and maintainability.
- Prisma ORM integrated for strong typing, model validation, and efficient database management.
- Simplified database operations with an easy-to-use query builder.

- **Database**: PostgreSQL and Redis
- Advanced SQL database with strong consistency and reliability for multi-tenancy user and application data.
- Ideal for scalable applications and large datasets.
- Redis offers low latency writes necessary for collecting usage stats on the reverse proxy

- **Reverse Proxy**: Golang
- Interfaces with the gateway kit to offer the reverse proxy.
- Performs authorization via API keys created by management system.
- Tracks usage for billing purposes.

### TEAM
#### [Raid Guild](https://www.raidguild.org/portfolio)
We are a selected Raiding Party custom built to tackle this unique POP. Raid Guild is a service DAO founded in late 2020 to provide clients access to a network of technical and creative Web3 builders. Our organization is flat and true to the ideals of the Ethereum ecosystem.

- **SAYONARA** - Lead Front End Dev
- **PLOR** - BackEnd Dev and Systems Engineer
- **BENEDICTVS** - Bis Dev
- **SASQUATCH** - Account/Project Management
---
## Proposal from RaidGuild

### Expected Deliverables
- **Design**
- Wireframes for the user portal
- Shared via figma for open use by community
- **Portal**
- User management
- Endpoint management
- Usage statistics and Rate limits
- Billing
- **Documentation**
- Gateway usage information
- Open source dev docs
- **Reverse Proxy**
- Routes to gateway kit
- Tracks per endpoint usage
- Rate limiting

### **Milestones**
---
#### Sprint 1:
> - Design assets produced and reviewed :heavy_check_mark:
> - Backend components scaffolding and architecture design :heavy_check_mark:

#### Sprint 2:
> - Portal initial development :heavy_check_mark:
> - Landing page and login:heavy_check_mark:
> - Database initialization :heavy_check_mark:

#### Sprint 3:
> - Portal user creation :heavy_check_mark:
> - Reverse proxy development :heavy_check_mark:

#### Sprint 4:
> - Portal endpoint creation :heavy_check_mark:
> - App side :heavy_check_mark:
> - Chain side :heavy_check_mark:
> - UI :heavy_check_mark:
> - Documentation setup :heavy_check_mark:
> - Per endpoint usage tracking :heavy_check_mark:

#### Sprint 5:
> - Portal usage and rate limiting :heavy_check_mark:
> - Payment accounting and processing :heavy_check_mark:

#### Sprint 6:
> - Portal accounting reporting and payments :heavy_check_mark:
> - Finalize documentation :heavy_check_mark:
> - Final backend deploys and configuration :heavy_check_mark:

----

## Proposal

| | Estimate | Time Estimate |
| ------------------ | ------------------- | ------------- |
| DESIGN | $ 6,000 | 3 weeks |
| PORTAL | $ 20,000 | 10 weeks |
| DOCS | $ 4,000 | 6 weeks |
| BACKEND | $ 25,000 | 10 weeks |
| **Total Estimate** | **$55,000** in POKT | **12 weeks** |

*Note: the above figures include administration and project management*
*Note: Silos above will work concurrently, total time estimate reflects this*