PRAISE_HK-clone System Requirements Document

1. Introduction

The PRAISE_HK-clone project aims to develop a route recommendation application that integrates with iWatch to provide public users with the best routes based on pollution exposure and travel time. The application will allow users to input their starting point and destination to receive route recommendations.

2. System Overview

The PRAISE_HK-clone is designed to offer route recommendations that minimize pollution exposure or balance between the fastest route and least exposure. It integrates with iWatch to enhance user experience and ease of use.

2a. Product Interpretation and Delivery Boundary

• Domain Descriptors:

  • Route Optimization: The app provides route recommendations based on pollution exposure and travel time.
  • Wearable Integration: Integration with iWatch to enhance user experience and ease of use.

• What is being built: A route recommendation app with iWatch integration for public users.

• Location: The application will use the Hong Kong map for route visualization.

• Excluded Assumptions: Generic e-commerce features, user account management.

• Custom Pages: Route Recommendation page.

• Access: Public access, no application-owned identity.

• Behavior Contracts:

  • Route Recommendation:
    • Actor: Public User
    • Trigger: User inputs starting point and destination
    • Observable Outcome: Recommended route with least pollutant exposure
    • State Lifetime: None
    • Identity Continuity: None
    • Audience Entry: Public
    • Touchpoints: iWatch, Mobile App
    • Failure Outcome: No route found
    • Provenance: Explicit

2b. Source Content Inventory

No authoritative content sources were specified.

2c. Page Content and Component Coverage

Route Recommendation Page

• Information:

  • Input fields for starting point and destination.
  • Display of recommended route with details on pollution exposure and travel time.

• Actions:

  • Submit button to process route recommendation.
  • Option to toggle between least pollutant exposure and fastest route.
  • Use of Hong Kong map for route visualization.

• Components:

  • Map display for visualizing the recommended route.
  • Integration with iWatch for notifications and updates.

• States:

  • Loading state while processing route.
  • Success state displaying the recommended route.
  • Error state if no route is found.

3. Functional Requirements

• As a Public User, I should be able to input my starting point and destination to receive a recommended route.
• As a Public User, I should be able to choose between a route with the least pollutant exposure or the fastest route.
• As a Public User, I should receive route recommendations on my iWatch for ease of access.
• As a Public User, I should be notified if no route can be found.

4. User Personas

• Public User: Primary users of the app for route recommendations. They seek routes with minimal pollution exposure or a balance between speed and exposure.

5. Core User Flows

Public User Flow

1. Input Starting Point and Destination:

   • User opens the app and inputs their starting point and destination.

2. Select Route Preference:

   • User selects preference for least pollutant exposure or fastest route.

3. Receive Route Recommendation:

   • App processes the input and displays the recommended route.
   • Route details are sent to the user's iWatch.

4. Handle Errors:

   • If no route is found, the user is notified with an error message.

6. Visuals Colors and Theme

• Primary: #007BFF (Blue)
• Primary Light: #66B2FF (Light Blue)
• Secondary: #6C757D (Gray)
• Accent: #28A745 (Green)
• Highlight: #FFC107 (Yellow)
• Background: #FFFFFF (White)
• Surface: #F8F9FA (Light Gray)
• Text: #212529 (Dark Gray)
• Text Muted: #6C757D (Muted Gray)
• Border: #DEE2E6 (Light Border Gray)

7. Signature Design Concept

The Route Recommendation page will feature a clean and intuitive design, focusing on ease of use and clarity. The map display will be the focal point, providing a clear visualization of the recommended route. The interface will be responsive, ensuring a seamless experience across devices, including iWatch integration for real-time updates and notifications.

8. Interaction Model & Motion Direction

• Interaction Model: Animated
  • Moderate scroll-triggered reveals and hover transitions.
  • Interactive elements with spring physics for a polished user experience.

9. Non-Functional Requirements

No additional non-functional requirements were inferred beyond those necessary for the stated behaviors.

10. Tech Stack

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

11. Assumptions and Constraints

• The application will not include generic e-commerce features or user account management.
• Integration with iWatch is essential for ease of use in recommending routes.

12. Glossary

• iWatch: A wearable device by Apple, used for notifications and updates.
• Pollutant Exposure: The level of pollution a user is exposed to while traveling a route.
• Route Recommendation: The process of suggesting a travel path based on specific criteria like pollution exposure and travel time.