# vijay193/government_bus architecture

> Architecture diagram of the GitHub repository vijay193/government_bus, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vijay193/government_bus
- Repository: https://github.com/vijay193/government_bus

## Overview

##### Project type and purpose
- This is a full-stack bus booking system.
- Frontend: React + TypeScript (Vite), TailwindCSS.
- Backend: Node.js + Express, MySQL, REST APIs.

##### File structure
- Top-level: App.tsx, index.tsx (entrypoints), vite.config.ts, tsconfig.json.
- “backend/”: Node.js + Express server (server.js), package.json.
- “pages/” & “components/”: React pages (BookingPage, AdminDashboardPage, etc.) and reusable UI modules (common, bus, admin, assistant).
- “contexts/” & “hooks/”: React context for Auth, custom hooks (useAuth, useVoiceRecognition).
- “services/”: API clients, command parsing, text-to-speech.
- “dist/”: built static assets + index.html (for production deployment).
- Configuration: .gitignore, package.json, package-lock.json.

##### Key insights from README
- Role-based access: User, Admin, Sub-Admin.
- Core features: auth (password & OTP), schedule management, seat booking with fare & discount logic, revenue analytics, pass cards, district-wise routes.
- External dependencies: MySQL DB, CORS, dotenv, UUID.

##### Main components & their interactions
a. Frontend (Browser)
- UI Layers:
– Pages (Home, Booking, Profile, Admin Dashboards)
– Components (Header, SeatLayout, Modals, VoiceAssistant)
- State & Logic:
– AuthContext (manages JWT or session)
– Hooks (useAuth, useVoiceRecognition)
- Services:
– api.ts (axios/fetch calls to backend)
– textToSpeech & commandParser modules (for voice assistant)
b. Backend (Express Server)
- REST API Endpoints:
– /auth (login, OTP verification, register)
– /schedules (CRUD schedules)
– /bookings (book, cancel, free-ticket eligibility)
– /analytics (revenue, district metrics)
– /users (role management, pass cards)
- Business Logic: discounts, eligibility rules, seat allocation.
- Middleware: CORS, dotenv config, UUID generation.
- Database Access: MySQL client/ORM layer.
c. Database (MySQL)
- Tables: Users, Roles, Schedules, Bookings, DistrictRoutes, PassCards, AnalyticsRecords
- Relationships:
– One-to-Many: User→Bookings, Schedule→Bookings
– Many-to-One or Many-to-Many as needed (District↔Routes)
d. External Services
- Email/SMS OTP gateway (for OTP login)
- Hosting/CDN (serving dist/ assets)
- Possible caching layer or analytics pipeline (optional)

##### Architectural patterns & design principles
- Layered architecture: Presentation (React) → Application/API (Express) → Data (MySQL)
- Role-based access control via route guards (ProtectedRoute/AdminRoute)
- Separation of concerns: UI components vs. business services vs. data models
- Single Page Application (SPA) with client-side routing and dynamic code splitting (Vite)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Client Layer"
        subgraph "Entry Points"
            App["App.tsx"]:::ui
            Index["index.tsx"]:::ui
        end
        subgraph "Config & Template"
            Vite["vite.config.ts"]:::ui
            TSConfig["tsconfig.json"]:::ui
            HTML["index.html"]:::ui
        end
        subgraph "Pages"
            Home["HomePage.tsx"]:::ui
            BookingP["BookingPage.tsx"]:::ui
            Login["LoginPage.tsx"]:::ui
            Register["RegisterPage.tsx"]:::ui
            NotFound["NotFoundPage.tsx"]:::ui
            Tracking["TrackingPage.tsx"]:::ui
            UserDash["UserDashboardPage.tsx"]:::ui
            Profile["ProfilePage.tsx"]:::ui
            PassCard["PassCardPage.tsx"]:::ui
            AdminLayout["AdminLayout.tsx"]:::ui
            AdminDash["AdminDashboardPage.tsx"]:::ui
            ManageSchedPage["ManageSchedulesPage.tsx"]:::ui
            RevenueAnalytics["RevenueAnalyticsPage.tsx"]:::ui
            UploadSched["UploadSchedulesPage.tsx"]:::ui
            BulkUser["BulkUserUploadPage.tsx"]:::ui
            UserMgmt["UserManagementPage.tsx"]:::ui
            Settings["SettingsPage.tsx"]:::ui
        end
        subgraph "Components"
            Button["Button.tsx"]:::ui
            Input["Input.tsx"]:::ui
            Card["Card.tsx"]:::ui
            Modal["Modal.tsx"]:::ui
            Captcha["Captcha.tsx"]:::ui
            ProtectedRoute["ProtectedRoute.tsx"]:::ui
            AdminRoute["AdminRoute.tsx"]:::ui
            UserRoute["UserRoute.tsx"]:::ui
            UserLayout["UserLayout.tsx"]:::ui
            ScheduleCard["ScheduleCard.tsx"]:::ui
            Seat["Seat.tsx"]:::ui
            SeatLayout["SeatLayout.tsx"]:::ui
            EditScheduleModal["EditScheduleModal.tsx"]:::ui
            EditUserModal["EditUserModal.tsx"]:::ui
            SubAdminFormModal["SubAdminFormModal.tsx"]:::ui
            VoiceAssistantModal["VoiceAssistantModal.tsx"]:::ui
            Header["Header.tsx"]:::ui
        end
        subgraph "Contexts & Hooks"
            AuthContext["AuthContext.tsx"]:::ui
            UseAuth["useAuth.ts"]:::ui
            UseVoiceRec["useVoiceRecognition.ts"]:::ui
            ManageSchedHook["ManageSchedulesPage.tsx"]:::ui
        end
        subgraph "Services"
            API_BASE["API_BASE_URL.ts"]:::ui
            APIClient["api.ts"]:::ui
            CommandParser["commandParser.ts"]:::ui
            TextToSpeech["textToSpeech.ts"]:::ui
        end
    end

    subgraph "API Layer"
        Server["server.js"]:::backend
        AuthRoutes["/auth routes"]:::backend
        SchedRoutes["/schedules routes"]:::backend
        BookingRoutes["/bookings routes"]:::backend
        AnalyticsRoutes["/analytics routes"]:::backend
        UserRoutes["/users routes"]:::backend
        Middleware["Middleware (CORS, dotenv, UUID)"]:::backend
        BusinessLogic["Business Logic"]:::backend
        DBAccess["DB Access (MySQL ORM)"]:::backend
    end

    subgraph "Persistence & External"
        DB[(MySQL Database)]:::database
        subgraph "Tables"
            US["Users"]
            RO["Roles"]
            SC["Schedules"]
            BO["Bookings"]
            DR["DistrictRoutes"]
            PC["PassCards"]
            AN["AnalyticsRecords"]
        end
        OTPService{{"OTP Gateway"}}:::external
        CDN{{"CDN / Hosting"}}:::external
    end

    %% Connections
    Home -->|"renders"| Header
    BookingP -->|"renders"| SeatLayout
    BookingP -->|"renders"| ScheduleCard
    Login -->|"uses"| AuthContext
    Register -->|"uses"| AuthContext
    AuthContext -->|"provides JWT"| APIClient
    APIClient -->|"HTTP requests"| Server
    Server -->|"registers routes"| AuthRoutes
    Server -->|"registers routes"| SchedRoutes
    Server -->|"registers routes"| BookingRoutes
    Server -->|"registers routes"| AnalyticsRoutes
    Server -->|"registers routes"| UserRoutes
    AuthRoutes -->|"calls"| BusinessLogic
    SchedRoutes -->|"calls"| BusinessLogic
    BookingRoutes -->|"calls"| BusinessLogic
    AnalyticsRoutes -->|"calls"| BusinessLogic
    UserRoutes -->|"calls"| BusinessLogic
    Server -->|"uses"| Middleware
    BusinessLogic -->|"queries"| DBAccess
    DBAccess -->|"executes SQL"| DB
    AuthRoutes -->|"calls"| OTPService
    Server -->|"serves assets"| CDN

    %% Click Events
    click App "https://github.com/vijay193/government_bus/blob/main//App.tsx"
    click Index "https://github.com/vijay193/government_bus/blob/main//index.tsx"
    click Vite "https://github.com/vijay193/government_bus/blob/main//vite.config.ts"
    click TSConfig "https://github.com/vijay193/government_bus/blob/main//tsconfig.json"
    click HTML "https://github.com/vijay193/government_bus/blob/main//index.html"
    click Home "https://github.com/vijay193/government_bus/blob/main//pages/HomePage.tsx"
    click BookingP "https://github.com/vijay193/government_bus/blob/main//pages/BookingPage.tsx"
    click Login "https://github.com/vijay193/government_bus/blob/main//pages/LoginPage.tsx"
    click Register "https://github.com/vijay193/government_bus/blob/main//pages/RegisterPage.tsx"
    click NotFound "https://github.com/vijay193/government_bus/blob/main//pages/NotFoundPage.tsx"
    click Tracking "https://github.com/vijay193/government_bus/blob/main//pages/TrackingPage.tsx"
    click UserDash "https://github.com/vijay193/government_bus/blob/main//pages/UserDashboardPage.tsx"
    click Profile "https://github.com/vijay193/government_bus/blob/main//pages/ProfilePage.tsx"
    click PassCard "https://github.com/vijay193/government_bus/blob/main//pages/PassCardPage.tsx"
    click AdminLayout "https://github.com/vijay193/government_bus/blob/main//pages/admin/AdminLayout.tsx"
    click AdminDash "https://github.com/vijay193/government_bus/blob/main//pages/admin/AdminDashboardPage.tsx"
    click ManageSchedPage "https://github.com/vijay193/government_bus/blob/main//pages/admin/ManageSchedulesPage.tsx"
    click RevenueAnalytics "https://github.com/vijay193/government_bus/blob/main//pages/admin/RevenueAnalyticsPage.tsx"
    click UploadSched "https://github.com/vijay193/government_bus/blob/main//pages/admin/UploadSchedulesPage.tsx"
    click BulkUser "https://github.com/vijay193/government_bus/blob/main//pages/admin/BulkUserUploadPage.tsx"
    click UserMgmt "https://github.com/vijay193/government_bus/blob/main//pages/admin/UserManagementPage.tsx"
    click Settings "https://github.com/vijay193/government_bus/blob/main//pages/admin/SettingsPage.tsx"
    click Button "https://github.com/vijay193/government_bus/blob/main//components/common/Button.tsx"
    click Input "https://github.com/vijay193/government_bus/blob/main//components/common/Input.tsx"
    click Card "https://github.com/vijay193/government_bus/blob/main//components/common/Card.tsx"
    click Modal "https://github.com/vijay193/government_bus/blob/main//components/common/Modal.tsx"
    click Captcha "https://github.com/vijay193/government_bus/blob/main//components/common/Captcha.tsx"
    click ProtectedRoute "https://github.com/vijay193/government_bus/blob/main//components/navigation/ProtectedRoute.tsx"
    click AdminRoute "https://github.com/vijay193/government_bus/blob/main//components/navigation/AdminRoute.tsx"
    click UserRoute "https://github.com/vijay193/government_bus/blob/main//components/navigation/UserRoute.tsx"
    click UserLayout "https://github.com/vijay193/government_bus/blob/main//components/navigation/UserLayout.tsx"
    click ScheduleCard "https://github.com/vijay193/government_bus/blob/main//components/bus/ScheduleCard.tsx"
    click Seat "https://github.com/vijay193/government_bus/blob/main//components/bus/Seat.tsx"
    click SeatLayout "https://github.com/vijay193/government_bus/blob/main//components/bus/SeatLayout.tsx"
    click EditScheduleModal "https://github.com/vijay193/government_bus/blob/main//components/admin/EditScheduleModal.tsx"
    click EditUserModal "https://github.com/vijay193/government_bus/blob/main//components/admin/EditUserModal.tsx"
    click SubAdminFormModal "https://github.com/vijay193/government_bus/blob/main//components/admin/SubAdminFormModal.tsx"
    click VoiceAssistantModal "https://github.com/vijay193/government_bus/blob/main//components/assistant/VoiceAssistantModal.tsx"
    click Header "https://github.com/vijay193/government_bus/blob/main//components/Header.tsx"
    click AuthContext "https://github.com/vijay193/government_bus/blob/main//contexts/AuthContext.tsx"
    click UseAuth "https://github.com/vijay193/government_bus/blob/main//hooks/useAuth.ts"
    click UseVoiceRec "https://github.com/vijay193/government_bus/blob/main//hooks/useVoiceRecognition.ts"
    click ManageSchedHook "https://github.com/vijay193/government_bus/blob/main//hooks/ManageSchedulesPage.tsx"
    click API_BASE "https://github.com/vijay193/government_bus/blob/main//services/API_BASE_URL.ts"
    click APIClient "https://github.com/vijay193/government_bus/blob/main//services/api.ts"
    click CommandParser "https://github.com/vijay193/government_bus/blob/main//services/commandParser.ts"
    click TextToSpeech "https://github.com/vijay193/government_bus/blob/main//services/textToSpeech.ts"
    click Server "https://github.com/vijay193/government_bus/blob/main//backend/server.js"
    click DBAccess "https://github.com/vijay193/government_bus/blob/main//backend/package.json"
    click DB "https://github.com/vijay193/government_bus/blob/main//dist/index.html"
    classDef ui fill:#D0E8FF,stroke:#0366d6,color:#000
    classDef backend fill:#FFE5B4,stroke:#d2691e,color:#000
    classDef database fill:#C8E6C9,stroke:#2e7d32,color:#000
    classDef external fill:#FFECB3,stroke:#ff8f00,color:#000
```
