System Requirements Document for rapid-fix

1. Introduction

The rapid-fix project aims to transform the Angel Tracker application from a demonstration tool into a fully functional business application for the Angel Tracker Installer Office in Limpopo, Polokwane. This involves removing all example data, implementing a robust security system, and providing a comprehensive Founder Control Center for managing company settings, user roles, and communication channels. The application is designed for use by the Founder, Admin, Office, Installer, and Customer personas, with a focus on security, precision, and operational efficiency.

2. System Overview

The rapid-fix system is a secure, role-based application designed to manage the operations of the Angel Tracker Installer Office. It includes features for company settings management, user role management, secure access protocols, and a chain-of-command messaging system. The system starts with no example data and retains existing design elements such as the black/gold theme, GPS demo route, and installer checklist.

2a. Product Interpretation and Delivery Boundary

The system is delivered as a custom application with app-owned identity management. It requires authentication for access to role-specific functionalities and enforces a strict security protocol using a master PIN system. The application is designed to operate within the constraints of the Angel Tracker Installer Office, with specific contact details and branding elements. Future enhancements are not included in the current scope.

2b. Source Content Inventory

Not applicable as no content source directive was provided.

2c. Page Content and Component Coverage

Landing

• Information/State: Introduction to Angel Tracker Installer Office, audience, and workflows.
• Primary Actions: None (informational).
• Components: Graphite background, gold-accented controls.
• States: Static display.

Login

• Information/State: Role selection, authentication inputs.
• Primary Actions: Role selection, PIN entry.
• Components: Role dropdown, PIN input fields.
• States: Initial setup, lockout handling.

Founder

• Information/State: Company settings, security vault, user management.
• Primary Actions: Update settings, set/update master PIN, manage users.
• Components: Input fields, upload button, PIN management.
• States: Initial setup, settings update, PIN change.

Reports/Support

• Information/State: Messaging system, customer contact routing.
• Primary Actions: Send messages, view messages.
• Components: To dropdown, message input.
• States: Message sent, message received.

Route

• Information/State: GPS demo route.
• Primary Actions: View route.
• Components: Map display.
• States: Route active.

Checklist

• Information/State: Installer six-photo checklist.
• Primary Actions: Complete checklist.
• Components: Photo upload, checklist items.
• States: Checklist in progress, checklist completed.

3. Functional Requirements

• As a Founder, I should be able to clear all example data to start with an empty client and job list. (explicit)
• As a Founder, I should be able to manage company master settings including trade name, registration number, logo, slogan, address, support email, and phone. (explicit)
• As a Founder, I should be able to set and update a master PIN in the Founder Security Vault. (explicit)
• As a Founder, I should be required to enter the company number and create a master PIN on first use. (explicit)
• As a Founder, I should be able to manage user roles and PINs, including blocking/unblocking users. (explicit)
• As a Founder, I should be able to send messages to the Admin only. (explicit)
• As an Admin, I should be able to communicate with Office and Installer roles and reply to the Founder. (explicit)
• As an Office user, I should be able to communicate with Installer, Customer, and Admin roles. (explicit)
• As an Installer, I should be able to communicate with Office and Admin roles. (explicit)
• As a Customer, I should be redirected to contact Admin when attempting to contact the Founder. (explicit)
• As any user, I should be blocked for five minutes after three incorrect PIN attempts. (explicit)
• As a Founder, I should be able to save all company master settings to localStorage with a gold "Update Master Configuration" button. (explicit)

4. User Personas

Founder

• Context: Manages the Angel Tracker Installer Office.
• Primary Goal: Securely configure and control company settings and user roles.
• Responsibilities: Manage company settings, security vault, user roles, and messaging.
• Success: A secured, correctly configured system with founder-only control over sensitive changes.

Admin

• Context: Coordinates operations within the chain of command.
• Primary Goal: Facilitate communication and operational workflows.
• Responsibilities: Communicate with Office and Installer, view master PIN.
• Success: Efficient coordination and communication within the organization.

Office

• Context: Manages communication between customers and field operations.
• Primary Goal: Ensure smooth communication flow through the chain of command.
• Responsibilities: Communicate with Installer, Customer, and Admin.
• Success: Effective routing of communications and customer support.

Installer

• Context: Conducts field operations and reports back to the office.
• Primary Goal: Complete field tasks and report through the chain of command.
• Responsibilities: Follow GPS demo route, complete checklist, communicate with Office and Admin.
• Success: Successful completion of field tasks and accurate reporting.

Customer

• Context: Seeks support and communication with the company.
• Primary Goal: Obtain support through the permitted communication path.
• Responsibilities: Contact Office for support, follow chain of command.
• Success: Receiving timely and appropriate support.

5. Core User Flows

5.1 Founder Setup and Configuration

1. Start: Open the application.
2. Login Page: Select "Founder" role.
3. Input: Enter company number and create master PIN.
4. Founder Page: Access company master settings.
5. Action: Update settings and save to localStorage.
6. Continuation: Manage users and send messages to Admin.

5.2 Admin Communication

1. Start: Open the application.
2. Login Page: Select "Admin" role.
3. Input: Enter employee PIN.
4. Reports/Support Page: Access messaging system.
5. Action: Send messages to Office and Installer, reply to Founder.
6. Continuation: Coordinate operations.

5.3 Office Communication

1. Start: Open the application.
2. Login Page: Select "Office" role.
3. Input: Enter employee PIN.
4. Reports/Support Page: Access messaging system.
5. Action: Send messages to Installer, Customer, and Admin.
6. Continuation: Route communications effectively.

5.4 Installer Field Operations

1. Start: Open the application.
2. Login Page: Select "Installer" role.
3. Input: Enter employee PIN.
4. Route Page: Follow GPS demo route.
5. Checklist Page: Complete six-photo checklist.
6. Continuation: Report completion to Office and Admin.

5.5 Customer Support

1. Start: Open the application.
2. Login Page: Select "Customer" role.
3. Reports/Support Page: Attempt to contact Founder.
4. Action: Redirected to contact Admin.
5. Continuation: Obtain support through Admin.

6. Visuals Colors and Theme

• Muse: MARQ by Garmin
• Palette:
  • Background: #1C1C1E
  • Surface: #2C2C2E
  • Text: #E5E5EA
  • Primary: #FFD700
  • Accent: #00A8E8
  • Muted: #6C6C6E
• Typography:
  • Headings: Saira Condensed, bold, uppercase
  • Body: Barlow Condensed
  • Scale: 1.25 modular, 48/36/24/18/16
• Shape Language: Circular gauges, dark titanium surfaces, ruled data rows
• Layout: Edge-to-edge hero with circular instrument panel sections
• Imagery: Macro shots of instrumentation, circular data displays, subtle topographic lines

7. Signature Design Concept

The public entry page features an oversized circular instrument panel set against a graphite background. Gold accents highlight key controls and data points, creating a luxurious and precise aesthetic. Interactive gauges and dials display real-time data, with a gold "Update Master Configuration" button offering a hover animation for visual feedback.

8. Interaction Model & Motion Direction

• Interaction Model: Animated
• Motion Tempo: Restrained
• Hero Dimensionality: Layered_2d
• Landing Hero Motion Brief: The hero features a circular instrument panel with needle sweeps for data updates. Upon user interaction, the panel transitions with slow turntable motions, highlighting key data points with gold accents. A reduced-motion state simplifies transitions for accessibility.

9. Non-Functional Requirements

• Performance: The application must load within 3 seconds on standard broadband connections.
• Security: All PINs must be securely stored and encrypted in localStorage.
• Usability: The interface must be intuitive and accessible, adhering to WCAG 2.1 AA standards.
• Reliability: The system must handle up to 100 concurrent users without performance degradation.

10. Tech Stack

• Frontend: React
• Backend: Python/FastAPI
• Storage: LocalStorage for client-side data persistence
• Deployment: Docker/docker-compose for containerization

11. Assumptions and Constraints

• Assumption: Users have basic familiarity with role-based access systems.
• Constraint: The system must operate within the specified design and branding guidelines.
• Assumption: The application will be used primarily on desktop devices.

12. Glossary

• Founder: The primary user responsible for managing company settings and security.
• Admin: A user role responsible for coordinating operations and communication.
• Office: A user role responsible for managing customer and field communications.
• Installer: A user role responsible for completing field operations and reporting.
• Customer: A user role seeking support and communication with the company.
• Master PIN: A security code used to access sensitive areas of the application.