System Requirements Document (SRD)

Project Name: sharp-router

1. Introduction

The sharp-router project aims to provide a seamless online payment system for internet users, enabling them to purchase a 30-day subscription plan for AED 20. This system integrates with the Mikrotik CRS326 router, leveraging Ziina's payment gateway API, Ngrok for public access, XAMPP for local hosting, and Mikhmon server for router management. The solution is tailored for users in the UAE, ensuring compatibility with local payment systems and user expectations.

This document outlines the system requirements necessary to implement and deploy the sharp-router platform effectively.

2. System Overview

The sharp-router system is designed to automate the process of internet subscription activation upon successful payment. Users will access the service through a public Ngrok URL, where they can securely pay AED 20 for a 30-day internet plan using Ziina's payment gateway. Once payment is confirmed, the system will communicate with the Mikrotik CRS326 router via Mikhmon server to activate the user's subscription.

Key components of the system include:

• Ngrok: Provides a public-facing URL for users to access the payment interface.
• XAMPP: Hosts the local server for backend operations.
• Ziina API: Facilitates secure payment processing.
• Mikhmon Server: Manages router configurations and user subscriptions.

The system is built to be user-friendly, efficient, and fully automated, ensuring minimal manual intervention.

3. Functional Requirements

User Stories:

• As a User, I should be able to access the payment interface via the Ngrok URL: https://reyes-aware-herman.ngrok-free.dev.
• As a User, I should be able to securely pay AED 20 for a 30-day internet plan using Ziina's payment gateway.
• As a User, I should receive confirmation of successful payment.
• As a System, I should automatically activate the user's subscription on the Mikrotik CRS326 router for 30 days upon payment confirmation.
• As an Admin, I should be able to monitor payment transactions and subscription activations via the XAMPP server.
• As an Admin, I should be able to configure and update the system settings, including payment API keys and router details.

4. User Personas

1. User

• Description: Internet users who wish to purchase a subscription plan.
• Goals: Access the internet by paying AED 20 for a 30-day plan.
• Pain Points: Need for a simple, secure, and fast payment process.

2. Admin

• Description: System administrator managing the router and payment system.
• Goals: Ensure smooth operation of the payment system and subscription activations.
• Pain Points: Need for reliable monitoring tools and easy configuration options.

5. Visuals Colors and Theme

Color Palette:

• Background: #F5F5F5 (Soft Pearl White)
• Surface: #E0E7FF (Light Lavender Blue)
• Text: #1F2937 (Charcoal Gray)
• Accent: #FF6F61 (Coral Red)
• Muted Tones: #CBD5E1 (Pale Steel Blue)

Theme:

The visual theme will reflect simplicity and modernity, emphasizing trust and security. The interface will feature clean lines, intuitive navigation, and responsive design optimized for mobile and desktop users.

6. Signature Design Concept

Interactive Payment Dashboard with Real-Time Router Activation Feedback

The homepage will feature a sleek, interactive dashboard where users can:

1. Initiate Payment: A prominent "Subscribe Now" button leads to a secure payment interface.
2. Real-Time Feedback: After payment, users will see a dynamic progress bar showing the activation process, with live updates from the Mikrotik router.
3. Visual Confirmation: A celebratory animation (e.g., confetti burst) confirms successful activation, creating a delightful user experience.

Additional Features:

• Micro-Interactions: Buttons and links will have subtle hover effects, enhancing user engagement.
• Responsive Design: The dashboard will adapt seamlessly to various screen sizes, ensuring accessibility for all users.
• Custom Animations: The background will feature a pulsating gradient inspired by the UAE's desert hues, transitioning between warm gold and cool blue tones.

7. Non-Functional Requirements

• Performance: The system must process payments and activate subscriptions within 5 seconds.
• Scalability: Support up to 1,000 concurrent users accessing the payment interface.
• Security: Ensure secure payment processing using HTTPS and Ziina's API encryption.
• Reliability: Achieve 99.9% uptime for the Ngrok URL and XAMPP server.
• Localization: Default currency set to AED, with support for Arabic and English languages.

8. Tech Stack

Frontend:

• React for Web

Backend:

• Python
• FastAPI

Database:

• MySQL (preferred) or MariaDB with Alembic for migrations

AI Tools:

• GPT 5.4 for user-friendly responses

Local Orchestration:

• Docker
• Docker-Compose

Server-Side Orchestration:

• Kubernetes

9. Assumptions and Constraints

Assumptions:

• Users will have access to the Ngrok URL for payment.
• Ziina's API will support AED transactions without additional fees.
• The Mikrotik CRS326 router is configured to accept API commands for subscription activation.

Constraints:

• The system relies on Ngrok for public access, which may have limitations on uptime or bandwidth.
• XAMPP server must remain operational for backend processes.
• Payment processing is limited to Ziina's API capabilities.

10. Glossary

• Ngrok: A tool that provides secure tunnels to localhost, enabling public access to local servers.
• XAMPP: A free and open-source cross-platform web server solution stack package.
• Mikhmon: A web-based application for managing Mikrotik routers.
• Ziina API: A payment gateway API designed for secure transactions in the UAE.
• Mikrotik CRS326: A network router used for managing internet connections and subscriptions.