windy-train System Requirements Document

Introduction

The "windy-train" project aims to develop a professional Railway Junction Parcel Management Mobile Application. This application is designed for workers and parcel supervisors who manage parcel loading and unloading operations at railway junctions. The primary goal is to streamline operations, reduce errors, and provide real-time updates to enhance efficiency.

System Overview

The "windy-train" application addresses daily operational challenges faced by railway parcel workers, such as missed train timings, parcel tracking issues, delayed loading/unloading, lack of worker monitoring, and absence of real-time updates for supervisors. By leveraging a professional railway-themed design, the application will provide an intuitive and immersive user experience.

Functional Requirements

• As a Worker, I should be able to securely log in using Firebase Authentication.
• As a Worker, I should be able to view my assigned train details, including train number, platform number, and parcel count.
• As a Worker, I should receive a 10-minute alert before train arrival with sound, vibration, and push notifications.
• As a Worker, I should update my task status using one-tap buttons for platform, loading, and unloading statuses.
• As a Supervisor, I should monitor worker activities, train status, and parcel status in real-time.
• As a Supervisor, I should view daily reports, worker reports, and delay analytics.
• As a Worker, I should scan a QR code to check in at the platform, automatically logging my entry time.
• As a Worker, I should have my actions automatically logged with details like worker name, train number, and timestamp.

User Personas

1. Workers: Responsible for loading and unloading parcels. They require quick access to task details and status updates.
2. Supervisors/Owners/Admin: Oversee operations, monitor worker activities, and ensure timely parcel management.

Visuals Colors and Theme

To reflect the professional railway theme, the following color palette is proposed:

• primary: #1A3E59 (Deep Blue)
• primary_light: #3C6E91 (Light Blue)
• secondary: #A62C2B (Crimson Red)
• accent: #FFD700 (Vibrant Gold)
• highlight: #FF8C00 (Warm Orange)
• bg: #F5F5F5 (Light Gray)
• surface: rgba(26, 62, 89, 0.8) (Deep Blue with transparency)
• text: #333333 (Dark Gray)
• text_muted: #777777 (Muted Gray)
• border: rgba(233, 69, 96, 0.2) (Subtle Crimson)

Signature Design Concept

The "windy-train" app will feature an interactive railway dashboard as its landing page. Users will see a stylized map of a railway junction, where each train is represented by a moving icon on the tracks. Workers can tap on a train icon to view and update their tasks. The dashboard will use framer-motion for smooth animations as trains move along the tracks, and gsap for scroll-triggered transitions when navigating through different sections of the app. This dynamic map will provide an engaging and intuitive way to manage tasks and monitor operations.

Interaction Model & Motion Direction

The landing page will use a "parallax" interaction model, providing a layered depth effect as users scroll through the app. Decorative elements like moving train icons and animated track lines will translate at different speeds, creating a visually rich first impression. Internal pages will maintain a "static" interaction model for clarity and ease of use, focusing on task management and reporting.

Non-Functional Requirements

• The application must support real-time synchronization and offline functionality.
• It should provide secure role-based access to different user types.
• The UI must be responsive and support dark mode for better visibility in various lighting conditions.

Tech Stack

• Frontend: Android Studio with Java or Flutter
• Backend: Flask API or Node.js
• Database: Firebase Firestore
• Notifications: Firebase Cloud Messaging (FCM)
• Local Storage: SQLite or Room Database for offline support

Assumptions and Constraints

• The application will primarily be used in railway junctions across India, considering local network conditions and device capabilities.
• The app must be compatible with Android devices commonly used by railway workers.

Glossary

• FCM: Firebase Cloud Messaging, used for sending notifications.
• QR Code: A machine-readable code used for quick check-ins.
• Parallax: A visual effect where background images move slower than foreground images, creating a sense of depth.

This document outlines the requirements and design considerations for the "windy-train" project, ensuring a professional and efficient parcel management solution for railway junctions.