coral-travel System Requirements Document

Introduction

The purpose of this document is to outline the system requirements for the "coral-travel" project, a mobile application designed to facilitate easy and convenient travel around the city of Ahmedabad. The application aims to integrate various modes of transportation, providing users with comprehensive travel options and real-time updates. The target user base includes both local residents and international visitors.

System Overview

The coral-travel application is intended to simplify daily travel for users in Ahmedabad by offering a unified platform that includes metro, bus, train, taxi, bike, and walking routes. The app will provide live travel updates, estimated travel times, route suggestions, and step-by-step directions. Additionally, it will include fare calculations, booking options, and alternative routes in case of strikes or disruptions.

Functional Requirements

• As a User, I should be able to enter my starting point and destination to receive the best route suggestions.
• As a User, I should be able to view live travel updates for my selected route.
• As a User, I should be able to see estimated travel times for each transportation option.
• As a User, I should be able to receive step-by-step directions for my journey.
• As a User, I should be able to view fare calculations for different transportation options.
• As a User, I should be able to book tickets or rides directly through the app.
• As a User, I should be able to receive alternative route suggestions in case of strikes or disruptions on my chosen route.

User Personas

• Traveler: A daily commuter or tourist, including international visitors, using the app to navigate the city efficiently.
• Administrator: A backend user responsible for managing transportation data and updates.

Core User Flows

• Traveler enters starting point and destination -> App suggests best route -> Traveler views live updates and estimated times -> Traveler follows step-by-step directions.
• Traveler checks fare -> Books ticket/ride -> Receives confirmation.
• Administrator updates transportation data -> System processes updates -> Users receive real-time information.

Visuals / Design Language

• primary: #1E90FF (Dodger Blue)
• primary_light: #63B8FF (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)
• whitespace: generous
• containers: rounded with soft shadows
• animations: elegant and smooth
• text: #000000 (Black)
• text_muted: #696969 (Dim Gray)
• border: rgba(0, 0, 0, 0.1)

Signature Design Concept

The coral-travel app will feature an interactive city map on the home screen, where users can visually explore different transportation options. The map will be dynamic, with animated routes that light up as users hover over them, providing a sense of movement and direction. Users can click on different modes of transport to see detailed information and options. The map will utilize @react-three/fiber for 3D effects and gsap for smooth animations, creating an engaging and intuitive user experience.

Interaction Model & Motion Direction

The landing page will employ a "parallax" interaction model, with layered depth effects as users scroll through different sections of the app. The map and route animations will provide a visually rich first impression, while the content remains easily accessible and navigable. Internal pages will be more static to ensure clarity and ease of use for detailed information.

Non-Functional Requirements

• The app must support both Android and iOS platforms.
• The system should handle up to 100,000 concurrent users.
• The app should provide updates with a latency of no more than 5 seconds.
• The system should ensure data security and user privacy.

Tech Stack

• Frontend: React Native for mobile app development.
• Backend: Python with FastAPI.
• Database: MySQL for relational data storage.
• AI Models: None specified.
• AI Tools: None specified.
• Local Orchestration: Docker for containerization.
• Server-side Orchestration: Kubernetes for managing deployment.

Assumptions and Constraints

• The app will only be available for users in Ahmedabad.
• Real-time data will be sourced from local transportation authorities.
• The app will require internet connectivity to function fully.

Glossary

• Route Suggestions: Recommendations for the best travel path based on user input.
• Live Travel Updates: Real-time information about transportation schedules and delays.
• Fare Calculations: Estimations of travel costs for different transportation modes.
• Booking Options: Ability to reserve or purchase tickets through the app.