spicy-bot System Requirements Document

Introduction

The purpose of this document is to outline the system requirements for the "spicy-bot" project, which aims to develop a website for physiotherapists. The website will serve as a Content Management System (CMS) and include a booking management module. The primary users of this system are patients who can book appointments, and staff who will manage these appointments.

System Overview

The spicy-bot project is designed to facilitate physiotherapists in managing their practice through a user-friendly website. The system will allow patients to book appointments online, while staff members will manage these bookings. The focus is on creating a simple and efficient setup that caters to the needs of both patients and staff.

Functional Requirements

• As a Patient, I should be able to book an appointment online.
• As a Patient, I should be able to view available appointment slots.
• As a Staff member, I should be able to manage and confirm patient appointments.
• As a Staff member, I should be able to update appointment availability.
• As a Patient, I should receive confirmation notifications for my appointments.
• As a Staff member, I should be able to access patient booking history.

User Personas

• Patient: Individuals seeking physiotherapy services who can book and manage their appointments online.
• Staff: Physiotherapy clinic staff responsible for managing appointments and patient interactions.

Core User Flows

• Patient books appointment -> Receives confirmation -> Attends appointment
• Staff updates availability -> Manages incoming bookings -> Confirms appointments

Visuals Colors and Theme

• primary: #3A86FF (a calming blue for trust and professionalism)
• primary_light: #A8CFFF (a lighter blue for hover states)
• secondary: #FF006E (a vibrant pink for emphasis and highlights)
• accent: #FFBE0B (a bright yellow for call-to-action elements)
• highlight: #FB5607 (a warm orange for notifications and active states)
• bg: #FFFFFF (a clean white background)
• surface: rgba(58, 134, 255, 0.1) (a subtle blue for card backgrounds)
• text: #333333 (a dark grey for primary text)
• text_muted: #777777 (a softer grey for secondary text)
• border: rgba(58, 134, 255, 0.2) (a subtle blue for borders)

Signature Design Concept

The homepage of spicy-bot will feature an interactive "Healing Journey" map. This map will visually represent the patient's journey through physiotherapy, with each stage being a clickable node. As users hover over each node, a brief description of that stage will appear, and clicking will provide more detailed information. The map will be animated using framer-motion to provide smooth transitions and interactions, creating an engaging and informative experience for users.

Interaction Model & Motion Direction

The landing page will utilize a "parallax" interaction model to create a layered depth effect as users scroll. This will enhance the storytelling aspect of the "Healing Journey" map, with different layers moving at varying speeds to create a dynamic and immersive experience. 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 both desktop and mobile devices.
• The website should load within 3 seconds on a standard internet connection.
• Data privacy and security must be ensured for all user information.

Tech Stack

• Frontend: React for Web
• Backend: Python with FastAPI
• Database: MySQL or MariaDB, using alembic for migrations
• Local Orchestration: Docker, docker-compose

Assumptions and Constraints

• The system will initially support English language only.
• The website will be hosted on a cloud platform with scalable resources.
• User authentication and authorization will be handled through a simple username and password system.

Glossary

• CMS: Content Management System
• Parallax: A scrolling effect where background images move slower than foreground images, creating an illusion of depth.
• Framer-motion: A library for creating animations in React applications.