System Requirements Document (SRD) for garnet-location

1. Introduction

The garnet-location project is designed to provide live location tracking capabilities for mobile numbers, specifically targeting businesses that need to track delivery personnel. This system aims to optimize logistics, ensure timely deliveries, and monitor fleet efficiency while adhering to privacy laws and user consent protocols. The project is tailored for deployment in India (IN), considering local regulations, timezone (IST), and user expectations.

This document outlines the system's requirements, including functional and non-functional aspects, user personas, visual design, and technical specifications.

2. System Overview

The garnet-location system will enable businesses to track the real-time location of their delivery personnel via a mobile application. The system will rely on app-based tracking, ensuring user privacy and compliance with legal requirements. Key features include:

• Real-time GPS-based location tracking.
• Route optimization for delivery efficiency.
• Secure user authentication and consent mechanisms.
• Integration with business dashboards for monitoring and reporting.

The system will be scalable, secure, and user-friendly, ensuring seamless adoption by businesses and their delivery teams.

3. Functional Requirements

As story points:

• As a Business Admin, I should be able to register my business and create accounts for delivery personnel.
• As a Delivery Personnel, I should be able to log in to the mobile app and allow location tracking.
• As a Business Admin, I should be able to view the live location of all delivery personnel on a map.
• As a Delivery Personnel, I should be able to view my assigned delivery routes and optimize them.
• As a Business Admin, I should be able to generate reports on delivery efficiency and route performance.
• As a Delivery Personnel, I should be able to pause or stop location tracking with proper justification.
• As a System, I should send notifications to delivery personnel and admins for route updates or delays.

4. User Personas

1. Business Admin

• Description: The primary user responsible for managing delivery operations and monitoring personnel.
• Key Actions: Register business, create accounts, view live locations, generate reports, and manage routes.

2. Delivery Personnel

• Description: The end-user whose location is tracked for delivery purposes.
• Key Actions: Log in, enable/disable tracking, view routes, and receive notifications.

5. Visuals Colors and Theme

Unique Color Palette for garnet-location:

• Background: #F4F9FF (Soft Sky Blue)
• Surface: #FFFFFF (Pure White)
• Text: #2E3A59 (Deep Navy Blue)
• Accent: #FF6F61 (Vibrant Coral Red)
• Muted Tones: #B0BEC5 (Cool Gray)

This palette reflects professionalism, trust, and clarity, aligning with the system's purpose of reliable location tracking.

6. Signature Design Concept

Interactive Route Map with Dynamic Animations

The homepage of the garnet-location system will feature an interactive 3D map that displays live delivery routes. Key features include:

• Dynamic Animations: Delivery personnel icons will move along the routes in real-time, with smooth transitions and pulsing effects to indicate active tracking.
• Hover Interactions: Hovering over a delivery icon will display a tooltip with the personnel's name, current location, and estimated delivery time.
• Route Highlights: Assigned routes will glow with a gradient effect, shifting from green (on-time) to red (delayed).
• Zoom and Pan: Users can zoom in and out or pan across the map for a detailed view of specific regions.
• Micro-Interactions: Clicking on a delivery icon will open a side panel with detailed information, including route history, delivery status, and performance metrics.

This design will create an engaging and visually appealing experience, making the system intuitive and memorable.

7. Non-Functional Requirements

• Scalability: The system must support up to 10,000 concurrent users without performance degradation.
• Security: All user data, including location information, must be encrypted in transit and at rest.
• Compliance: The system must adhere to Indian privacy laws, including obtaining explicit user consent for location tracking.
• Availability: The system must maintain 99.9% uptime to ensure reliable tracking.
• Performance: Location updates must occur within 5 seconds of real-time.

8. Tech Stack

Frontend:

• React for the web dashboard.
• React Native for the mobile app.

Backend:

• Python with FastAPI for API development.

Database:

• MySQL for relational data storage, using Alembic for migrations.

AI Tools:

• Litellm for LLM routing.
• Langchain for workflow orchestration.

Local Orchestration:

• Docker and docker-compose for containerization.

Server-Side Orchestration:

• Kubernetes for deployment and scaling.

9. Assumptions and Constraints

Assumptions:

• Delivery personnel will have smartphones with GPS capabilities.
• Businesses will ensure their personnel install the mobile app and provide necessary permissions.
• The system will primarily operate within India, adhering to local regulations.

Constraints:

• The system's accuracy depends on the availability of GPS signals and internet connectivity.
• Legal restrictions may limit the scope of location tracking without explicit user consent.

10. Glossary

• GPS: Global Positioning System, used for location tracking.
• Admin: A business user responsible for managing delivery operations.
• Delivery Personnel: Individuals whose locations are tracked for delivery purposes.
• Route Optimization: The process of finding the most efficient delivery path.
• Consent: Explicit permission provided by users for location tracking.

End of Document