Zaddy VPN System Requirements Document

1. Introduction

The purpose of this document is to outline the system requirements for the Zaddy VPN project. The project aims to create a comprehensive VPN service that aggregates all free VPNs globally, providing users with a secure and private browsing experience. The system will include separate websites for the admin panel and customer page, with advanced AI capabilities for managing user access.

2. System Overview

Zaddy VPN is designed to offer users a wide selection of VPN services, with features that enhance privacy, security, and usability. The system will consist of two main components: an admin panel for managing VPN services and user access, and a customer-facing website for accessing VPN services. The admin panel will leverage AI to generate unique login credentials for users, ensuring secure and exclusive access.

3. Functional Requirements

• As an Admin, I should be able to add ~100 more real, legitimate VPNs to bring the list to ~40 solid entries.
• As an Admin, I should be able to create a "Zaddy Recommended" section highlighting the best VPNs.
• As a Customer, I should be able to use a comparison tool to compare VPNs side by side.
• As a Customer, I should be able to filter VPNs by categories like "Best for streaming", "Best for privacy", "Best for mobile".
• As an Admin, I should be able to add B shield Net VPN to the list.
• As a Customer, I should be able to use more than 10 VPNs at a time to enhance privacy.
• As an Admin, I should be able to generate login usernames and passwords using AI for customer access.
• As an Admin, I should be able to set the expiry date for each login credential.
• As a Customer, I should be able to log in using the credentials provided by the admin.

4. User Personas

• Admin: Responsible for managing VPN entries, generating user credentials, and setting login expiry dates.
• Customer: Uses the VPN services, compares different VPNs, and accesses the platform using credentials provided by the admin.

5. Core User Flows

• Admin adds new VPNs -> Admin generates login credentials using AI -> Admin sets expiry dates for credentials -> Customer logs in using credentials -> Customer accesses and compares VPNs -> Customer uses multiple VPNs simultaneously.

6. Visuals Colors and Theme

• primary: #1A73E8 (a deep blue for brand identity)
• primary_light: #E8F0FE (a lighter tint of primary for hover states)
• secondary: #FF6F61 (a coral hue for emphasis and links)
• accent: #FFD700 (a vibrant gold for CTAs and active states)
• highlight: #FFA500 (an orange for hover states and notifications)
• bg: #F5F5F5 (a light grey for the page background)
• surface: rgba(255, 255, 255, 0.9) (a white card/panel background)
• text: #202124 (a dark grey for primary text)
• text_muted: #5F6368 (a softer grey for secondary text)
• border: rgba(0, 0, 0, 0.1) (a subtle border color)

7. Signature Design Concept

The Zaddy VPN landing page will feature an interactive "VPN Galaxy" concept. Users will navigate a 3D galaxy where each star represents a VPN service. Hovering over a star reveals details about the VPN, and clicking on it opens a detailed comparison card. The galaxy will rotate and zoom as users explore, creating an immersive experience. This will be implemented using @react-three/fiber and @react-three/drei for 3D interactions, with gsap for smooth animations and transitions.

8. Interaction Model & Motion Direction

The landing page will use a "parallax" interaction model, with layered depth effects as users scroll. The VPN Galaxy will provide a visually rich first impression, with decorative layers moving at different speeds to create a sense of depth. Internal pages will maintain a "static" model for clarity and ease of use.

9. Non-Functional Requirements

• The system must ensure secure access control for all users.
• The AI must generate unique and secure login credentials.
• The system should support high concurrency for multiple VPN connections.

10. Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MongoDB
• AI Tools: Litellm for LLM Routing, Langchain
• Local Orchestration: Docker, docker-compose
• Server-side Orchestration: Kubernetes

11. Assumptions and Constraints

• The system assumes a stable internet connection for optimal VPN performance.
• The AI must be capable of generating secure credentials efficiently.
• The system must comply with local data protection regulations in Nigeria.

12. Glossary

• VPN: Virtual Private Network, a service that encrypts internet traffic and protects online identity.
• AI: Artificial Intelligence, used here for generating login credentials.
• Admin Panel: A backend interface for managing VPN services and user access.
• Customer Page: A frontend interface for users to access VPN services.