# simrail/map-v2 architecture

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

- Interactive diagram: https://gitdiagram.com/simrail/map-v2
- Repository: https://github.com/simrail/map-v2

## Overview

##### High-Level Architecture Components

a) Frontend Applications
- Home Portal (packages/home)
- Interactive Map (packages/map)
- Common Package (packages/common)

b) External Services/Integrations
- Steam Integration (evident from steam.ts and SteamProfile.ts)
- Server-side Components (indicated by server directory)

**┌─ SimRail System ──────────────────────┐**

- ┌─ Frontend Layer ─────────────┐     │

- ┌─ Home ─┐   ┌─ Map ─┐     │     │
- Portal │   │ App   │     │     │
- ┘   └───────┘     │     │
- ▲          ▲         │     │
- ┬───┘         │     │
- ▼             │     │
- ┌─ Common ─┐         │     │
- Package  │         │     │
- ┘         │     │
- ┬──────────────┘     │

- ┌─ External ───▼──────────────┐     │
- Steam API Integration    │     │
- ┘     │
- ┘

##### Component Details

For each component, include these specific details:

a) Home Portal (www.simrail.app):
- React/Vite application
- Routing functionality
- Feature cards component
- Footer component

b) Application (map.simrail.app):
- Next.js application
- Components (Markers, Stations, Signals)
- Search functionality
- Train tracking system
- Navigation controls

c) Common Package:
- Shared utilities
- Types
- Constants

##### Data Flow Indicators

- User navigation flow between Home and Map
- API calls to Steam services
- Data flow between components
- State management paths

##### Technical Stack Indicators

- React/Next.js
- TypeScript
- CSS Modules
- Vite
- Steam API

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph SimRail["SimRail System"]
        subgraph FrontendLayer["Frontend Layer"]
            subgraph HomePortal["Home Portal (www.simrail.app)"]
                Home["Main Home App"]:::frontend
                FeatureCards["Feature Cards"]:::frontend
                Footer["Footer"]:::frontend
                Home --> FeatureCards
                Home --> Footer
            end

            subgraph MapApp["Map Application (map.simrail.app)"]
                MapMain["Main Map Component"]:::frontend
                Search["Spotlight Search"]:::frontend
                NavControls["Navigation Controls"]:::frontend
                TopNav["Top Navigation"]:::frontend
                
                subgraph MarkerSystem["Marker System"]
                    StationMarker["Station Markers"]:::frontend
                    SignalMarker["Signal Markers"]:::frontend
                    TrainMarker["Train Markers"]:::frontend
                end
                
                subgraph TrainTracking["Train Tracking System"]
                    TrainList["Train List"]:::frontend
                    TrainPopup["Train Popup"]:::frontend
                    TrainContext["Train Context"]:::frontend
                end
                
                MapMain --> MarkerSystem
                MapMain --> Search
                MapMain --> NavControls
                MapMain --> TopNav
                MapMain --> TrainTracking
                TrainContext --> TrainList
                TrainContext --> TrainPopup
            end

            subgraph Common["Common Package"]
                CommonUtils["Shared Utilities"]:::common
                Types["Types"]:::common
                Constants["Constants"]:::common
            end

            HomePortal --> Common
            MapApp --> Common
        end

        subgraph DataLayer["Data Layer"]
            StationsData["Stations Data"]:::data
            SignalsData["Signals Data"]:::data
            RailcarsData["Railcars Data"]:::data
        end

        subgraph External["External Services"]
            Steam["Steam API Integration"]:::external
            SteamTypes["Steam Types"]:::external
        end

        MarkerSystem --> DataLayer
        TrainTracking --> Steam
        Steam --> SteamTypes
    end

    %% Click events for component mapping
    click Home "https://github.com/simrail/map-v2/blob/main/packages/home/src/Home.tsx"
    click FeatureCards "https://github.com/simrail/map-v2/blob/main/packages/home/src/components/FeatureCard.tsx"
    click Footer "https://github.com/simrail/map-v2/blob/main/packages/home/src/components/Footer.tsx"
    click MapMain "https://github.com/simrail/map-v2/blob/main/packages/map/components/Map.tsx"
    click Search "https://github.com/simrail/map-v2/blob/main/packages/map/components/SpotlightSearch.tsx"
    click NavControls "https://github.com/simrail/map-v2/blob/main/packages/map/components/NavigationDropdown.tsx"
    click TopNav "https://github.com/simrail/map-v2/blob/main/packages/map/components/TopNavigation.tsx"
    click StationMarker "https://github.com/simrail/map-v2/blob/main/packages/map/components/Markers/StationMarker.tsx"
    click SignalMarker "https://github.com/simrail/map-v2/blob/main/packages/map/components/Markers/SignalMarker.tsx"
    click TrainMarker "https://github.com/simrail/map-v2/blob/main/packages/map/components/Markers/TrainMarker.tsx"
    click TrainList "https://github.com/simrail/map-v2/blob/main/packages/map/components/TrainsList.tsx"
    click TrainPopup "https://github.com/simrail/map-v2/blob/main/packages/map/components/SelectedTrainPopup.tsx"
    click TrainContext "https://github.com/simrail/map-v2/blob/main/packages/map/contexts/SelectedTrainContext.tsx"
    click Steam "https://github.com/simrail/map-v2/blob/main/packages/map/components/steam.ts"
    click SteamTypes "https://github.com/simrail/map-v2/blob/main/packages/map/types/SteamProfile.ts"
    click Common "https://github.com/simrail/map-v2/tree/main/packages/common/"
    click CommonUtils "https://github.com/simrail/map-v2/blob/main/packages/common/index.ts"
    click StationsData "https://github.com/simrail/map-v2/blob/main/packages/map/components/stations.json"
    click SignalsData "https://github.com/simrail/map-v2/blob/main/packages/map/components/signals.json"
    click RailcarsData "https://github.com/simrail/map-v2/blob/main/packages/map/components/railcars.json"

    %% Styling
    classDef frontend fill:#2374ab,color:#fff,stroke:#fff
    classDef common fill:#707070,color:#fff,stroke:#fff
    classDef external fill:#2ecc71,color:#fff,stroke:#fff
    classDef data fill:#f1c40f,color:#333,stroke:#333

    %% Legend
    subgraph Legend
        Frontend["Frontend Component"]:::frontend
        CommonComp["Common Component"]:::common
        ExternalServ["External Service"]:::external
        DataComp["Data Component"]:::data
    end
```
