System Requirements Document (SRD) for shiny-platform

1. Introduction

This document outlines the system requirements for the development of shiny-platform, a scalable web platform designed for Social Collage. The platform aims to provide a seamless and user-friendly experience for service discovery, customer engagement, and operational management. The project is tailored for the Indian market, with locale-specific considerations such as time zones (IST), currency (INR), and regional scalability.

The platform will serve as a centralized system to manage service discovery, customer enquiries/bookings, operational workflows, and franchise lead generation, with a focus on scalability and future expansion.

2. System Overview

The shiny-platform is designed to meet the following objectives:

• Establish a professional and scalable digital presence for Social Collage.
• Enable structured service discovery for multiple user segments.
• Implement a flexible booking/enquiry system with search and filter functionality.
• Centralize operational control through an admin dashboard.
• Enable franchise lead capture and management.
• Build a system that supports future expansion (multi-city, mobile app, CRM integration).

The platform will include a responsive design, optimized for mobile, tablet, and desktop devices, ensuring accessibility and usability across all user segments.

3. Functional Requirements

3.1 Service Management Module

• As Admin, I should be able to create and manage service categories like Home Cleaning, Office Cleaning, etc.
• As Admin, I should be able to add/edit/delete services via the admin panel.
• As User, I should be able to view service detail pages, including descriptions, scope of work, benefits, and images.
• As User, I should be able to search and filter services by type and location.

3.2 Booking/Enquiry Management System

• As User, I should be able to select a service and fill out an enquiry/booking form with fields like name, phone, email, service type, location, preferred date & time, and additional notes.
• As User, I should receive a confirmation message upon submission.
• As Admin, I should receive notifications for new enquiries and view them in the admin dashboard.

3.3 Admin Dashboard Module

• As Admin, I should be able to manage services, categories, and content dynamically.
• As Admin, I should be able to view and filter enquiries by date, service type, location, and status.
• As Admin, I should be able to manage franchise leads and export data if required.
• As Admin, I should be able to view basic reports, including total enquiries, service-wise insights, and franchise lead counts.

3.4 Franchise Module

• As User, I should be able to access a dedicated franchise page with business overview, benefits, and an enquiry form.
• As Admin, I should be notified of new franchise enquiries and manage them in the admin panel.

3.5 Contact & Lead Management

• As User, I should be able to submit a contact form with fields like name, phone, email, and message.
• As Admin, I should receive notifications for new contact submissions.
• As User, I should be able to view Google Maps integration for location details.

3.6 Location & Scalability Design

• As User, I should be able to filter services by location.
• As Admin, I should be able to manage multi-city expansion and location-based service filtering.

3.7 Responsive Design & Performance

• As User, I should experience a mobile-first UI design with cross-browser compatibility and optimized loading performance.

4. User Personas

4.1 Admin

• Manages services, enquiries, franchise leads, and content.
• Requires access to reports and notifications for operational efficiency.

4.2 User

• Searches for services, submits enquiries/bookings, and interacts with the platform for service discovery.

4.3 Franchise Partner

• Explores franchise opportunities and submits enquiries through the dedicated franchise page.

5. Visuals Colors and Theme

Color Palette

• Background: #F5F8FA (Soft Sky Blue)
• Surface: #FFFFFF (Pure White)
• Text: #2C3E50 (Deep Charcoal)
• Accent: #FF6F61 (Warm Coral)
• Muted: #B0BEC5 (Cool Gray)

This palette reflects a clean, professional, and approachable aesthetic, aligning with the platform's purpose.

6. Signature Design Concept

The shiny-platform homepage will feature an Interactive Service Map.

• Visuals: A dynamic map of India will serve as the centerpiece, with city markers representing service locations. Hovering over a city marker will display a tooltip with available services and a "View Services" button.
• Animations: Smooth zoom-in and fade-in effects will activate as users interact with the map. The background will feature subtle animations of cleaning tools (e.g., brooms, vacuums) floating in and out of view.
• Interaction: Users can click on a city marker to navigate to a location-specific service listing page. The map will also include a search bar for direct city/service queries.
• Micro-interactions: Buttons and icons will have hover effects, such as color shifts and slight enlargements, to enhance user engagement.

This concept ensures a memorable first impression while emphasizing the platform's scalability and service reach.

7. Non-Functional Requirements

• Performance: The platform should load within 3 seconds on a 4G connection.
• Scalability: Support for multi-city operations and up to 1 million users.
• Security: Implement SSL encryption, secure authentication, and role-based access control.
• Localization: Support for Indian languages (e.g., Hindi, Tamil) in future phases.
• Accessibility: WCAG 2.1 compliance for users with disabilities.

8. Tech Stack

Frontend

• React for Web
• React Native for Mobile App

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

AI Models

• GPT 5.4 for user-friendly responses
• Google Nano Banana for image generation

AI Tools

• Langchain
• Litellm for LLM Routing

Orchestration

• Docker
• Kubernetes

9. Assumptions and Constraints

• The platform will initially focus on Chennai, with plans for multi-city expansion.
• The search and filter system will be limited to service type and location in the initial phase.
• Franchise management features will be basic in Phase 1, with advanced CRM integration planned for future updates.

10. Glossary

• Admin: The user responsible for managing the platform's backend operations.
• User: An individual or business seeking cleaning services.
• Franchise Partner: A potential business partner interested in expanding the service network.
• Enquiry: A request submitted by a user for a specific service.
• Responsive Design: A design approach ensuring usability across devices (mobile, tablet, desktop).