# aymanamkassou/flight-route-visualizer architecture

> Architecture diagram of the GitHub repository aymanamkassou/flight-route-visualizer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aymanamkassou/flight-route-visualizer
- Repository: https://github.com/aymanamkassou/flight-route-visualizer

## Overview

##### Project Type & Purpose
- It’s a full-stack application with a clear separation between the backend (implemented in C++ for core algorithms and the HTTP server) and the frontend (a Next.js-powered interactive visualization interface).
- The project focuses on aviation route visualization with real-time pathfinding features (using Dijkstra’s algorithm and BFS) and animated simulations of aircraft movement.

##### Main Components
a. Frontend:
– Next.js application under the “frontend/flight-route-visualizer” directory.
– Key modules/components:
- Interactive Map (components/Map.tsx)
- Visualization Controls (components/VisualizationControls.tsx)
- Animation Information and hooks (e.g., usePathAnimation.ts)
- Global styling and layout (app/layout.tsx, globals.css)
– Role: Presents the visualization, interacts with users, and sends API requests to the backend.

b. Backend:
– C++ server found in the “backend/src” directory.
– Key submodules:
- Graph Module: Contains the CSR graph and node representations (files in backend/src/graph)
- Server Module: Implements the HTTP server and REST API endpoints (backend/src/server)
- Utilities: DataLoader for reading airports and waypoints information (backend/src/utils)
- Main entry-point: (backend/src/main.cpp) which boots the server.
– Role: Processes API requests, loads and manipulates aviation data, and computes optimal paths.

c. Data Sources:
– Airport data (backend/data/airports.json)
– Waypoint data (backend/data/waypoints.csv)
– These feed into the pathfinding algorithms and are utilized during server startup/data loading.

##### Relationships and Interactions
- The frontend sends HTTP requests to the backend’s API endpoints (e.g., GET /api/graph and POST /api/find-path).
- The backend receives requests, invokes corresponding graph algorithms (Dijkstra/BFS), accesses structured data (using DataLoader), and returns computed path data and visualization steps.
- The real-time responses provide the frontend with information to animate the route and aircraft movement on the map.

##### Architectural Patterns & Principles
- Clear separation of concerns with distinct frontend and backend modules.
- The backend follows a modular design: segmentation into graph, server, and utility components for better maintainability.
- The use of CSR (Compressed Sparse Row) data structures is an optimization strategy for in-memory graph representations.
- RESTful API design for easy interaction between the client and server.

##### Relevant Technologies, Frameworks, and Libraries
- Backend: C++, cpprestsdk for HTTP server functionality, and possibly Boost libraries.
- Frontend: Next.js, React (components/hooks), Tailwind CSS for styling, and JavaScript/TypeScript for interactivity.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Subgraph
    subgraph "Frontend"
        F1("Next.js Application"):::frontend
        F2("Interactive Map"):::frontend
        F3("Visualization Controls"):::frontend
        F4("Animation Hook"):::frontend
        F5("Global Styling/Layout"):::frontend
    end

    %% Backend Subgraph
    subgraph "Backend"
        B1("C++ Server (Main Entry)"):::backend
        B2("Graph Module (CSR)"):::backend
        B3("Server Module (HTTP/REST API)"):::backend
        B4("Utilities Module (DataLoader)"):::backend
    end

    %% Data Sources Subgraph
    subgraph "Data Sources"
        D1("Airports Data"):::data
        D2("Waypoints Data"):::data
    end

    %% Frontend Internal Relationships
    F1 -->|"contains"| F2
    F1 -->|"contains"| F3
    F1 -->|"contains"| F4
    F1 -->|"contains"| F5

    %% Backend Internal Relationships
    B1 -->|"boots"| B3
    B3 -->|"invokes"| B2
    B3 -->|"calls"| B4
    B4 -->|"reads"| D1
    B4 -->|"reads"| D2

    %% Frontend to Backend Interaction
    F1 -->|"HTTP_Request/Response"| B3

    %% Styles
    classDef frontend fill:#cfe2f3,stroke:#333,stroke-width:2px;
    classDef backend fill:#f4cccc,stroke:#333,stroke-width:2px;
    classDef data fill:#e2efda,stroke:#333,stroke-width:2px;

    %% Click Events for Frontend Components
    click F1 "https://github.com/aymanamkassou/flight-route-visualizer/tree/main/frontend/flight-route-visualizer"
    click F2 "https://github.com/aymanamkassou/flight-route-visualizer/blob/main/frontend/flight-route-visualizer/src/components/Map.tsx"
    click F3 "https://github.com/aymanamkassou/flight-route-visualizer/blob/main/frontend/flight-route-visualizer/src/components/VisualizationControls.tsx"
    click F4 "https://github.com/aymanamkassou/flight-route-visualizer/blob/main/frontend/flight-route-visualizer/src/hooks/usePathAnimation.ts"
    click F5 "https://github.com/aymanamkassou/flight-route-visualizer/blob/main/frontend/flight-route-visualizer/src/app/layout.tsx"

    %% Click Events for Backend Components
    click B1 "https://github.com/aymanamkassou/flight-route-visualizer/blob/main/backend/src/main.cpp"
    click B2 "https://github.com/aymanamkassou/flight-route-visualizer/tree/main/backend/src/graph"
    click B3 "https://github.com/aymanamkassou/flight-route-visualizer/tree/main/backend/src/server"
    click B4 "https://github.com/aymanamkassou/flight-route-visualizer/tree/main/backend/src/utils"

    %% Click Events for Data Sources
    click D1 "https://github.com/aymanamkassou/flight-route-visualizer/blob/main/backend/data/airports.json"
    click D2 "https://github.com/aymanamkassou/flight-route-visualizer/blob/main/backend/data/waypoints.csv"
```
