System Requirements Document (SRD) for mossy-services

1. Introduction

Welcome to the System Requirements Document (SRD) for mossy-services, a project designed to create a comprehensive service platform for ordering official documents from Uganda and Kuwait. This document outlines the functional and non-functional requirements, user personas, design concepts, and technical specifications for the project.

The platform, titled "Jay Documentation Hub", will provide a seamless experience for customers to browse, select, and order document processing services. It will also include a robust admin panel for managing services, orders, and customer reviews. This SRD ensures that all aspects of the project are clearly defined and aligned with the vision of Jay Styles.

2. System Overview

Jay Documentation Hub is a service platform tailored for users in Uganda and Kuwait to order official documents. The system will include:

• A user-friendly interface for browsing and ordering services.
• Integration with WhatsApp for communication and order confirmations.
• A hidden admin panel for managing services, orders, and customer reviews.
• LocalStorage for offline data persistence.

The platform will operate in the following currencies:

• Ugandan Shillings (UGX) for Uganda-based services.
• Kuwaiti Dinar (KWD) for Kuwait-based services.

The exchange rate (1 KWD = 850,000 UGX) will be editable via the admin panel. The system will also include a 20% profit margin on all fixed-price services.

3. Functional Requirements

User Stories:

• As a User, I should be able to browse services by category (Uganda or Kuwait).
• As a User, I should be able to search for services using a search bar.
• As a User, I should be able to add fixed-price services to my cart.
• As a User, I should be able to view my cart and adjust quantities before checkout.
• As a User, I should be able to fill out a checkout form with my name, phone, WhatsApp, and delivery method.
• As a User, I should be able to confirm my order, which sends the details via WhatsApp to the business.
• As a User, I should be able to submit a review with a star rating and comment.
• As a User, I should be able to view published reviews on the Ratings & Reviews page.

Admin Stories:

• As an Admin, I should be able to log in to the admin panel at /admin using the password admin123.
• As an Admin, I should be able to edit any service price (both UGX and KWD).
• As an Admin, I should be able to add new services with a name, country, price, and type (fixed or variable).
• As an Admin, I should be able to delete any service.
• As an Admin, I should be able to edit the business name, phone number, WhatsApp number, and email.
• As an Admin, I should be able to edit the exchange rate (KWD to UGX).
• As an Admin, I should be able to view all customer orders placed through the site.
• As an Admin, I should be able to mark orders as "Pending," "Processing," "Completed," or "Delivered."
• As an Admin, I should be able to view all customer reviews submitted.
• As an Admin, I should be able to approve or reject customer reviews for public display.

4. User Personas

1. Customer

• Description: A user who visits the platform to order document processing services.
• Goals: Browse services, place orders, and leave reviews.
• Pain Points: Difficulty finding reliable document services; lack of clear pricing.

2. Admin

• Description: The business owner or staff managing the platform.
• Goals: Manage services, orders, and reviews; ensure smooth operation of the platform.
• Pain Points: Time-consuming manual updates; need for offline data persistence.

5. Visuals Colors and Theme

Color Palette:

• Background: #1A1F36 (Dark Blue)
• Surface: #2E3A59 (Muted Navy)
• Text: #F5F5F5 (Soft White)
• Accent: #FFD700 (Gold)
• Muted Tones: #A0A8C1 (Light Gray-Blue)

This palette reflects a professional and elegant aesthetic, aligning with the platform's purpose of providing premium document services.

6. Signature Design Concept

Interactive Document Carousel with Glassmorphism

The homepage will feature an interactive document carousel that showcases the most popular services (e.g., National ID, Passport, Civil ID). Each service will be displayed as a glassmorphic card with a subtle 3D hover effect. When users hover over a card:

• The card will "lift" slightly with a glowing gold border.
• A short description and price will fade in.
• Clicking the card will open a detailed service page with an "Add to Cart" button.

The background will feature a dynamic gradient animation (dark blue to gold) that shifts subtly as users scroll. Micro-interactions, such as button clicks and hover effects, will use smooth transitions to enhance the user experience.

7. Non-Functional Requirements

• Performance: The website must load within 2 seconds on a standard 4G connection.
• Responsiveness: Fully responsive design for mobile, tablet, and desktop devices.
• Data Persistence: All data (services, orders, reviews) must persist using LocalStorage.
• Security: Admin panel must be password-protected.
• Accessibility: Ensure WCAG 2.1 compliance for visually impaired users.

8. Tech Stack

Frontend:

• React for Web

Backend:

• Python
• FastAPI

Database:

• MySQL (with Alembic for migrations)

AI Tools:

• GPT 5.4 for user-friendly responses
• Litellm for LLM routing

Orchestration:

• Docker
• docker-compose

9. Assumptions and Constraints

• The platform will operate in Uganda and Kuwait only.
• All data will be stored locally using LocalStorage (no external database).
• The admin panel will be accessible only via /admin with the password admin123.
• Exchange rates and service prices are subject to manual updates by the admin.

10. Glossary

• LocalStorage: A web storage API that allows data to be stored in the browser.
• Glassmorphism: A design trend featuring translucent surfaces with a frosted-glass effect.
• KWD: Kuwaiti Dinar.
• UGX: Ugandan Shilling.
• WCAG: Web Content Accessibility Guidelines.

This concludes the updated SRD for mossy-services. Let me know if there are any additional changes or features you'd like to include, Jay!