# electrium-mobility/electriumap architecture

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

- Interactive diagram: https://gitdiagram.com/electrium-mobility/electriumap
- Repository: https://github.com/electrium-mobility/electriumap

## Overview

##### Project type and purpose
- From the root files (frontend/ and backend/ folders) and the README, this is a full-stack web mapping application (“The Map of the Future”).
- Frontend is built with Next.js (React, TypeScript), integrating MapBox and Firebase.
- Backend is a lightweight upload handler (JavaScript) plus a static page.

##### File structure
- Top-level:
- frontend/ – a Next.js app (package.json, tsconfig.json, src/app, public/images).
- backend/ – a standalone static page (index.html, styles.css) plus upload-handler.js.
- README files and repo config (.gitignore, CODEOWNERS, license, etc.).
- frontend/src/app: follows Next.js App Router conventions, with subfolders for pages:
- create-account, login, API routes (api/outlets → route.ts).
- Components folder contains MapBox.tsx, Overlay.tsx, heatmap.tsx, plus static pins.json.
- firebase folder for Firebase client init.
- backend/upload-handler.js suggests a micro-service (e.g., an AWS Lambda/Netlify Function) that processes file uploads.

##### README for additional insights
- No database folder in backend → likely uses static JSON (pins.json) or relies on Firebase for persistence.

##### Elements
- Labels for each component (e.g., “Next.js Frontend,” “Serverless Upload Function,” “Firebase Auth,” “MapBox API”).
- Browser → CDN/Next.js
- Next.js → Firebase Auth
- Next.js → /api/outlets → Data Store
- Browser → MapBox
- Browser → upload-handler → Cloud Storage

## Diagram (Mermaid)

```mermaid
graph TD
    %% Client and CDN
    Browser("Web Browser"):::external
    CDN("Static Asset Hosting/CDN"):::service

    Browser -->|Loads assets| CDN
    CDN -->|Serves| NextjsApp

    %% Frontend Next.js App
    subgraph "Next.js Frontend" 
        direction TB
        NextjsApp("Next.js Frontend App"):::frontend
        subgraph "Config & Entry"
            direction TB
            NextConfig["next.config.ts"]:::frontend
            PackageJson["package.json"]:::frontend
            TsConfig["tsconfig.json"]:::frontend
        end
        subgraph "UI Components"
            direction TB
            UIComponents("Components Folder"):::frontend
            MapBoxComp["MapBox.tsx"]:::frontend
            OverlayComp["Overlay.tsx"]:::frontend
            HeatmapComp["heatmap.tsx"]:::frontend
            PinsJson["pins.json"]:::frontend
            Utils["utils.ts"]:::frontend
        end
        subgraph "App Router Pages"
            direction TB
            HomePage["page.tsx (Home)"]:::frontend
            subgraph "Create Account Flow"
                direction TB
                CreateAccountPage["page.tsx"]:::frontend
                UserDataContext["UserDataContext.tsx"]:::frontend
                ProfilePage["ProfilePage.tsx"]:::frontend
                SettingUpPage["SettingUpPage.tsx"]:::frontend
                VehiclePage["VehiclePage.tsx"]:::frontend
                WelcomePage["WelcomePage.tsx"]:::frontend
            end
            subgraph "Login Flow"
                direction TB
                LoginPage["LoginPage.tsx"]:::frontend
                LoginPageRoute["page.tsx"]:::frontend
            end
        end
        subgraph "API Layer"
            direction TB
            OutletsRoute["route.ts (/api/outlets)"]:::service
            ReadOutlets["readOutlets.ts"]:::service
        end
        subgraph "Firebase Client"
            direction TB
            FirebaseInit["firebase.ts"]:::service
        end
        subgraph "Static GeoJSON"
            direction TB
            LandGeoJSON["ne_10m_land_geojson.json"]:::frontend
        end
        subgraph "Global Styling & Layout"
            direction TB
            GlobalsCSS["globals.css"]:::frontend
            GlobalsTS["globals.ts"]:::frontend
            LayoutComp["layout.tsx"]:::frontend
        end
    end

    %% Backend Microservice & Static Site
    subgraph "Backend Services"
        direction TB
        UploadHandler["upload-handler.js"]:::backend
        subgraph "Static Site"
            direction TB
            BackendIndex["index.html"]:::backend
            BackendStyles["styles.css"]:::backend
            BackendReadme["README.md"]:::backend
        end
    end

    %% External Services
    subgraph "External Services"
        direction TB
        FirebaseAuth["Firebase Authentication"]:::external
        FirebaseDB["Firebase Firestore/Storage"]:::external
        MapBoxAPI["MapBox API"]:::external
        CloudStorage["Cloud Storage / S3"]:::external
    end

    %% Data Stores
    pinsDB["pins.json (static data)"]:::service

    %% Interactions
    Browser -->|Init SDK| FirebaseInit
    FirebaseInit -->|Auth flows| FirebaseAuth
    Browser -->|Fetch map tiles| MapBoxAPI
    Browser -->|Calls| OutletsRoute
    OutletsRoute -->|Reads| pinsDB
    OutletsRoute -->|Validates token| FirebaseAuth
    Browser -->|Posts upload| UploadHandler
    UploadHandler -->|Stores| CloudStorage
    OutletsRoute -->|Optionally reads/writes| FirebaseDB

    %% Click Events
    click NextjsApp "https://github.com/electrium-mobility/electriumap/tree/dev/frontend/"
    click NextConfig "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/next.config.ts"
    click PackageJson "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/package.json"
    click TsConfig "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/tsconfig.json"
    click MapBoxComp "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/Components/MapBox.tsx"
    click OverlayComp "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/Components/Overlay.tsx"
    click HeatmapComp "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/Components/heatmap.tsx"
    click PinsJson "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/Components/pins.json"
    click Utils "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/Components/utils.ts"
    click HomePage "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/page.tsx"
    click CreateAccountPage "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/create-account/page.tsx"
    click UserDataContext "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/create-account/UserDataContext.tsx"
    click ProfilePage "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/create-account/profile/ProfilePage.tsx"
    click SettingUpPage "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/create-account/setting-up/SettingUpPage.tsx"
    click VehiclePage "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/create-account/vehicle/VehiclePage.tsx"
    click WelcomePage "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/create-account/welcome/WelcomePage.tsx"
    click LoginPage "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/login/LoginPage.tsx"
    click LoginPageRoute "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/login/page.tsx"
    click OutletsRoute "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/api/outlets/route.ts"
    click ReadOutlets "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/api/readOutlets.ts"
    click FirebaseInit "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/firebase/firebase.ts"
    click LandGeoJSON "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/landpolygon/ne_10m_land_geojson.json"
    click GlobalsCSS "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/globals.css"
    click GlobalsTS "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/globals.ts"
    click LayoutComp "https://github.com/electrium-mobility/electriumap/blob/dev/frontend/src/app/layout.tsx"
    click UploadHandler "https://github.com/electrium-mobility/electriumap/blob/dev/backend/upload-handler.js"
    click BackendIndex "https://github.com/electrium-mobility/electriumap/blob/dev/backend/index.html"
    click BackendStyles "https://github.com/electrium-mobility/electriumap/blob/dev/backend/styles.css"
    click BackendReadme "https://github.com/electrium-mobility/electriumap/blob/dev/backend/README.md"

    %% Styles
    classDef frontend fill:#AEDFF7,stroke:#036897,color:#000
    classDef backend fill:#FFC4A3,stroke:#FF8800,color:#000
    classDef service fill:#D5F5E3,stroke:#27AE60,color:#000
    classDef external fill:#F9E79F,stroke:#B7950B,color:#000
```
