Sweet-System

Introduction

The Sweet-System project is designed to create an online platform for a plumbing service. This platform will facilitate users in scheduling plumbing repairs and appointments online, enhancing the accessibility and efficiency of the service.

System Overview

Sweet-System aims to provide a user-friendly interface for customers to book plumbing services online. The system will include features such as online appointment scheduling, repair service listings, and customer support. The platform will be accessible via web browsers and will cater to users in India, considering locale-specific defaults such as currency (INR) and timezone (IST).

Functional Requirements

• As a User, I should be able to view a list of available plumbing repair services.
• As a User, I should be able to schedule an online appointment for plumbing services.
• As a User, I should be able to receive confirmation of my scheduled appointment.
• As an Admin, I should be able to manage and update the list of available services.
• As an Admin, I should be able to view and manage scheduled appointments.

User Personas

• User: Individuals seeking plumbing services who can browse services and schedule appointments online.
• Admin: Personnel responsible for managing service listings and appointments.

Core User Flows

• User visits the website -> browses available plumbing services -> selects a service -> schedules an appointment -> receives confirmation.
• Admin logs into the system -> updates service listings -> reviews scheduled appointments -> manages appointments.

Visuals Colors and Theme

• primary: #1E90FF (Dodger Blue)
• primary_light: #87CEFA (Light Sky Blue)
• secondary: #FF6347 (Tomato)
• accent: #32CD32 (Lime Green)
• highlight: #FFD700 (Gold)
• bg: #F0F8FF (Alice Blue)
• surface: rgba(255, 255, 255, 0.9)
• text: #000000 (Black)
• text_muted: #696969 (Dim Gray)
• border: rgba(0, 0, 0, 0.1)

Signature Design Concept

The homepage of Sweet-System will feature an interactive 3D plumbing toolkit using @react-three/fiber and @react-three/drei. Users can click on different tools to explore services related to each tool. As users hover over a tool, it will animate with a slight rotation and glow effect, inviting interaction. This engaging concept will make the website memorable and encourage users to explore the services offered.

Interaction Model & Motion Direction

The landing page will utilize a "parallax" interaction model, creating a layered depth effect as users scroll through the page. Decorative elements like pipes and water droplets will move at different speeds, enhancing the storytelling aspect of the service offerings. Internal pages will maintain a "static" interaction model for clarity and ease of use.

Non-Functional Requirements

• The system should be responsive and accessible on all major web browsers.
• The platform must handle concurrent user sessions efficiently.
• Data security and user privacy must be ensured, complying with local regulations.

Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• Local Orchestration: Docker, docker-compose
• Server-side Orchestration: Kubernetes

Assumptions and Constraints

• The system will primarily serve users in India, hence all time-related functionalities will adhere to IST.
• The platform will use INR as the default currency for any transactions or pricing information.
• The online appointment scheduling functionality is pre-approved and will be integrated using a suitable API.

Glossary

• User: An individual seeking plumbing services.
• Admin: Personnel managing the service offerings and appointments.
• API: Application Programming Interface, used for integrating online appointment scheduling.
• IST: Indian Standard Time.
• INR: Indian Rupee, the currency of India.