# mrunsten/solita-dev-academy-2023-exercise architecture

> Architecture diagram of the GitHub repository mrunsten/solita-dev-academy-2023-exercise, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mrunsten/solita-dev-academy-2023-exercise
- Repository: https://github.com/mrunsten/solita-dev-academy-2023-exercise

## Overview

##### Component Details

a. Client Layer:
- Web browsers connecting to the system
- Both desktop and mobile clients (as mobile support is implemented)

b. Application Layer (Container Level):
- Nginx Reverse Proxy Container
- Port 3000 exposed to clients
- Routes traffic to appropriate services

- Frontend Container (SvelteKit)
- Main routes (/journeys, /stations, /station/[id])
- TypeScript and Svelte components

- Backend Container (Rust)
- Main API endpoints
- Modules:
- API handlers (journey.rs, station.rs)
- Database interfaces
- Data source handlers
- Model definitions

c. Data Layer:
- PostgreSQL Database Container
- Port 5432
- Main tables:
- cities
- station_operators
- stations
- journeys
- Materialized views:
- journey_list
- station
- station_list

- Client requests → Nginx
- Nginx → Frontend/Backend routing
- Backend → Database queries
- Data source imports → Backend → Database
- Response paths back to clients

##### Special Elements

- A "Data Import" section showing:
- CSV data sources
- Validation rules (10s minimum duration, 10m minimum distance)
- Duplicate checking

##### Additional Details

Annotations for:
- Docker container boundaries
- Environment variable configurations
- Port mappings
- Data validation rules
- Technology stack labels (Rust, SvelteKit, PostgreSQL, Nginx)

##### Important Architectural Patterns to Highlight

- Microservices architecture (containerized services)
- RESTful API design
- MVC-like pattern in the backend
- Data validation pipeline
- View materialization for performance

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef client fill:#f9f9f9,stroke:#333
    classDef proxy fill:#e6e6e6,stroke:#333
    classDef frontend fill:#dae8fc,stroke:#6c8ebf
    classDef backend fill:#d5e8d4,stroke:#82b366
    classDef database fill:#ffe6cc,stroke:#d79b00
    classDef datasource fill:#f5f5f5,stroke:#666
    
    %% Client Layer
    subgraph Clients
        Browser["Web Browser"]:::client
        Mobile["Mobile Browser"]:::client
    end

    %% Application Layer
    subgraph "Application Layer"
        Nginx["Nginx Reverse Proxy\nPort 3000"]:::proxy
        
        subgraph "Frontend Container"
            FE_Routes["SvelteKit Routes"]:::frontend
            Journeys["Journeys Route"]:::frontend
            Stations["Stations Route"]:::frontend
            StationDetail["Station Detail Route"]:::frontend
        end
        
        subgraph "Backend Container"
            API["API Handlers"]:::backend
            JourneyAPI["Journey API"]:::backend
            StationAPI["Station API"]:::backend
            Models["Data Models"]:::backend
            DBInterface["Database Interface"]:::backend
        end
    end

    %% Data Layer
    subgraph "Data Layer"
        DB[(PostgreSQL\nPort 5432)]:::database
        subgraph "Database Tables"
            Cities[("cities")]:::database
            StationOps[("station_operators")]:::database
            StationsTable[("stations")]:::database
            Journeys_Table[("journeys")]:::database
        end
        
        subgraph "Materialized Views"
            JourneyList[("journey_list")]:::database
            StationView[("station")]:::database
            StationList[("station_list")]:::database
        end
    end

    %% Data Import
    subgraph "Data Sources"
        CSV["CSV Files"]:::datasource
        Validation["Data Validation\n- 10s min duration\n- 10m min distance\n- Duplicate check"]:::datasource
    end

    %% Relationships
    Browser --> Nginx
    Mobile --> Nginx
    Nginx --> FE_Routes
    Nginx --> API
    
    FE_Routes --> Journeys
    FE_Routes --> Stations
    FE_Routes --> StationDetail
    
    API --> JourneyAPI
    API --> StationAPI
    JourneyAPI --> DBInterface
    StationAPI --> DBInterface
    
    DBInterface --> DB
    
    CSV --> Validation
    Validation --> API
    
    DB --> Cities
    DB --> StationOps
    DB --> StationsTable
    DB --> Journeys_Table
    DB --> JourneyList
    DB --> StationView
    DB --> StationList

    %% Click Events
    click Journeys "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/frontend/src/routes/journeys/[[page]]/+page.svelte"
    click Stations "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/frontend/src/routes/stations/[[page]]/+page.svelte"
    click StationDetail "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/frontend/src/routes/station/[id]/+page.svelte"
    click JourneyAPI "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/backend/src/api/journey.rs"
    click StationAPI "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/backend/src/api/station.rs"
    click DBInterface "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/backend/src/database.rs"
    click Models "https://github.com/MRunsten/solita-dev-academy-2023-exercise/tree/main/backend/src/model"
    click Nginx "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/reverse_proxy/nginx.conf"
    click JourneyList "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/backend/queries/postgres/11-create_view_journey_list.sql"
    click StationView "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/backend/queries/postgres/12-create_view_station.sql"
    click StationList "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/backend/queries/postgres/13-create_view_station_list.sql"
    click StationsTable "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/backend/queries/postgres/03-create_table_stations.sql"
    click Journeys_Table "https://github.com/MRunsten/solita-dev-academy-2023-exercise/blob/main/backend/queries/postgres/04-create_table_journeys.sql"
    click CSV "https://github.com/MRunsten/solita-dev-academy-2023-exercise/tree/main/backend/src/datasource"
```
