System Requirements Document (SRD) for purple-project

1. Introduction

Welcome to the System Requirements Document (SRD) for purple-project. This document outlines the functional and non-functional requirements for a referral-based commission system tailored to meet the needs of Hanif Hossen in the UAE. The system is designed to facilitate product sales, track referrals, and calculate commissions seamlessly. It aims to empower customers to earn rewards through referrals while providing administrators with robust tools for managing sales and commissions.

2. System Overview

The purple-project is a web-based platform designed to support a referral-based commission model. The system allows customers to purchase products and earn a percentage of profits (e.g., 10%) when they refer others who make purchases. Key features include product management, referral tracking, commission calculation, and payment management. The platform will cater to both customers and administrators, ensuring ease of use and transparency in operations.

The system will operate in the UAE timezone (GMT+4) and support AED as the default currency for transactions. It will be accessible via both web and mobile applications, ensuring flexibility and convenience for users.

3. Functional Requirements

Customer Features:

• As a Customer, I should be able to browse and purchase products.
• As a Customer, I should be able to refer others to the platform using a unique referral link.
• As a Customer, I should be able to track the commissions earned from my referrals.
• As a Customer, I should be able to view my account details, including referral history and commission balance.

Admin Features:

• As an Admin, I should be able to manage the product catalog, including stock and pricing updates.
• As an Admin, I should be able to monitor referral activity and commission payouts.
• As an Admin, I should be able to generate reports on sales, referrals, and commissions.
• As an Admin, I should be able to configure the commission percentage (e.g., 10%).

4. User Personas

Customer:

• Description: Individuals who purchase products and refer others to earn commissions.
• Goals: To buy products, refer others, and earn rewards.
• Pain Points: Difficulty tracking referrals and commissions; lack of transparency in earnings.

Admin:

• Description: Business owners or managers who oversee product sales, referrals, and commission payouts.
• Goals: To manage products, monitor referral activity, and ensure accurate commission calculations.
• Pain Points: Complexity in managing large volumes of data; ensuring system reliability and accuracy.

5. Visuals Colors and Theme

The purple-project will feature a unique color palette inspired by the project's name and the vibrant energy of the UAE market. The theme will be modern, clean, and user-friendly.

Color Palette:

• Background: #F3E5F5 (Lavender Mist)
• Surface: #D1C4E9 (Soft Purple)
• Text: #311B92 (Deep Indigo)
• Accent: #7B1FA2 (Royal Purple)
• Muted Tones: #B39DDB (Light Lilac)

This palette ensures a visually appealing interface that aligns with the project's identity while maintaining readability and accessibility.

6. Signature Design Concept

The purple-project will feature a dynamic referral dashboard as its signature design concept.

Concept Details:

• Homepage Design: The landing page will showcase a live referral tree visualization, where users can see their referral network grow in real-time. Each node in the tree represents a referred customer, and clicking on a node reveals detailed information about their purchases and commissions.
• Animations: Smooth transitions will animate the referral tree as new nodes are added, creating a sense of growth and achievement.
• Interactive Elements: Users can hover over nodes to see quick stats or click to drill down into detailed reports.
• Color Shifts: The referral tree will use the accent color (#7B1FA2) for active nodes and muted tones (#B39DDB) for inactive ones, creating a visually engaging experience.
• Micro-Interactions: Subtle animations, such as glowing effects on active nodes, will enhance user engagement.

This design will make the platform instantly fascinating and encourage users to actively participate in the referral program.

7. Non-Functional Requirements

• Performance: The system should handle up to 10,000 concurrent users without degradation in performance.
• Scalability: The platform should be scalable to accommodate future growth in users and data volume.
• Security: All user data, including referral and commission details, must be encrypted and stored securely.
• Accessibility: The system should comply with WCAG 2.1 standards to ensure accessibility for users with disabilities.
• Localization: The platform should support AED currency and Arabic language options for UAE users.

8. Tech Stack

Frontend:

• React for Web
• React Native for Mobile App

Backend:

• Python
• FastAPI

Database:

• MySQL or MariaDB (preferred for relational data)
• Alembic for database migrations

AI Models:

• GPT 5.4 for user-friendly responses
• Claude 4.6 Opas for academic or coding work

AI Tools:

• Litellm for LLM Routing
• Langchain

Orchestration:

• Docker for local development
• Kubernetes for server-side orchestration

9. Assumptions and Constraints

Assumptions:

• Customers will actively use the referral system to earn commissions.
• The commission percentage will remain fixed at 10%, unless updated by the admin.
• The platform will primarily target users in the UAE.

Constraints:

• The system must comply with UAE regulations for online transactions and data privacy.
• The platform must support AED as the default currency.

10. Glossary

• Referral: The act of a customer recommending the platform to others.
• Commission: The percentage of profit earned by a customer for successful referrals.
• Admin: The user responsible for managing the platform and overseeing operations.
• Node: A visual representation of a referred customer in the referral tree.
• WCAG: Web Content Accessibility Guidelines, ensuring the platform is accessible to all users.

End of Document