# ropperp/eeg-platform architecture

> Architecture diagram of the GitHub repository ropperp/eeg-platform, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ropperp/eeg-platform
- Repository: https://github.com/ropperp/eeg-platform

## Overview

EEG-Plattform is a multi-tenant SaaS for renewable-energy communities. Members and managers enter through the web portal; managers administer members, import metering data and handle billing, while members view consumption and invoices. Public dashboards expose aggregated live data, and a separate control center administers platform services. Assembly records, support, authentication and PDF generation are distinct product capabilities. The README documents the broad product flows; sampled source confirms routing, assembly handling and selected service wiring, but not every subsystem’s runtime links.

Main entry points: [`webapp/routes/portal.php`](https://github.com/ropperp/eeg-platform/blob/main/webapp/routes/portal.php) (Portal routes), [`webapp/src/Router.php`](https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Router.php) (Request router), [`konsole/src/App.php`](https://github.com/ropperp/eeg-platform/blob/main/konsole/src/App.php) (Platform control center), [`webapp/public/index.php`](https://github.com/ropperp/eeg-platform/blob/main/webapp/public/index.php) (Web entry point)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web experience"]
  node_entry["Web entry point<br/>[index.php]"]
  node_router["Request router<br/>[Router.php]"]
  node_portal["Portal routes<br/>[portal.php]"]
  node_api["API routes<br/>[api.php]"]
  node_live["Live dashboard<br/>[LiveStatsCache.php]"]
end

subgraph group_domain["Community operations"]
  node_members["Member management<br/>[portal.php]"]
  node_billing["Billing<br/>[Billing.php]"]
  node_assembly["Assembly records"]
  node_support["Support tickets"]
end

subgraph group_data["Data and documents"]
  node_eda["EDA import<br/>[EdaImportJobs.php]"]
  node_parser["EDA parser<br/>[parser.py]"]
  node_mqtt["Metering ingest<br/>[main.py]"]
  node_pdf["PDF generation<br/>[service.js]"]
  node_database[("Platform database<br/>[DB.php]")]
end

subgraph group_identity["Identity and access"]
  node_auth["Authentication<br/>[Auth.php]"]
  node_keycloak["Keycloak identity<br/>[KeycloakOidc.php]"]
end

subgraph group_platform["Platform services"]
  node_konsole["Platform control center<br/>[App.php]"]
end

node_users(("Members and managers"))
node_http(("Web requests"))

node_users -->|"submit requests"| node_http
node_http -->|"enters through"| node_entry
node_entry -->|"dispatches to"| node_router
node_router -->|"routes portal"| node_portal
node_router -->|"routes API"| node_api
node_portal -->|"checks login"| node_auth
node_users -.->|"authenticates with"| node_keycloak
node_portal -->|"offers management"| node_members
node_portal -->|"handles billing"| node_billing
node_portal -->|"manages imports"| node_eda
node_eda -.->|"parses EDA data"| node_parser
node_mqtt -->|"writes measurements"| node_database
node_live -.->|"reads aggregates"| node_database
node_users -->|"views public data"| node_live
node_portal -->|"manages assemblies"| node_assembly
node_assembly -->|"renders documents"| node_pdf
node_portal -->|"handles support"| node_support
node_konsole -->|"integrates SSO"| node_keycloak
node_konsole -->|"serves administrators"| node_users

click node_entry "https://github.com/ropperp/eeg-platform/blob/main/webapp/public/index.php"
click node_router "https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Router.php"
click node_portal "https://github.com/ropperp/eeg-platform/blob/main/webapp/routes/portal.php"
click node_api "https://github.com/ropperp/eeg-platform/blob/main/webapp/routes/api.php"
click node_auth "https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Auth.php"
click node_keycloak "https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Infrastructure/Auth/KeycloakOidc.php"
click node_members "https://github.com/ropperp/eeg-platform/blob/main/webapp/routes/portal.php"
click node_billing "https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Billing.php"
click node_eda "https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Domain/EdaImport/EdaImportJobs.php"
click node_parser "https://github.com/ropperp/eeg-platform/blob/main/eda-parser/parser.py"
click node_mqtt "https://github.com/ropperp/eeg-platform/blob/main/mqtt-subscriber/main.py"
click node_live "https://github.com/ropperp/eeg-platform/blob/main/webapp/src/LiveStatsCache.php"
click node_assembly "https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Domain/Assembly/AssemblyService.php"
click node_pdf "https://github.com/ropperp/eeg-platform/blob/main/latex-service/service.js"
click node_database "https://github.com/ropperp/eeg-platform/blob/main/webapp/src/DB.php"
click node_support "https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Domain/Support/SupportTicketService.php"
click node_konsole "https://github.com/ropperp/eeg-platform/blob/main/konsole/src/App.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry,node_router,node_portal,node_api,node_live toneBlue
class node_members,node_billing,node_assembly,node_support toneAmber
class node_eda,node_parser,node_mqtt,node_pdf,node_database,node_http toneMint
class node_auth,node_keycloak toneRose
class node_konsole,node_users toneIndigo
```

## Components

### Web experience

- [Web entry point](https://github.com/ropperp/eeg-platform/blob/main/webapp/public/index.php): `webapp/public/index.php`
- [Request router](https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Router.php): `webapp/src/Router.php`
- [Portal routes](https://github.com/ropperp/eeg-platform/blob/main/webapp/routes/portal.php): `webapp/routes/portal.php`
- [API routes](https://github.com/ropperp/eeg-platform/blob/main/webapp/routes/api.php): `webapp/routes/api.php`
- [Live dashboard](https://github.com/ropperp/eeg-platform/blob/main/webapp/src/LiveStatsCache.php): `webapp/src/LiveStatsCache.php`

### Community operations

- [Member management](https://github.com/ropperp/eeg-platform/blob/main/webapp/routes/portal.php): `webapp/routes/portal.php`
- [Billing](https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Billing.php): `webapp/src/Billing.php`
- [Assembly records](https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Domain/Assembly/AssemblyService.php): `webapp/src/Domain/Assembly/AssemblyService.php`
- [Support tickets](https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Domain/Support/SupportTicketService.php): `webapp/src/Domain/Support/SupportTicketService.php`

### Data and documents

- [EDA import](https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Domain/EdaImport/EdaImportJobs.php): `webapp/src/Domain/EdaImport/EdaImportJobs.php`
- [EDA parser](https://github.com/ropperp/eeg-platform/blob/main/eda-parser/parser.py): `eda-parser/parser.py`
- [Metering ingest](https://github.com/ropperp/eeg-platform/blob/main/mqtt-subscriber/main.py): `mqtt-subscriber/main.py`
- [PDF generation](https://github.com/ropperp/eeg-platform/blob/main/latex-service/service.js): `latex-service/service.js`
- [Platform database](https://github.com/ropperp/eeg-platform/blob/main/webapp/src/DB.php): `webapp/src/DB.php`

### Identity and access

- [Authentication](https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Auth.php): `webapp/src/Auth.php`
- [Keycloak identity](https://github.com/ropperp/eeg-platform/blob/main/webapp/src/Infrastructure/Auth/KeycloakOidc.php): `webapp/src/Infrastructure/Auth/KeycloakOidc.php`

### Platform services

- [Platform control center](https://github.com/ropperp/eeg-platform/blob/main/konsole/src/App.php): `konsole/src/App.php`

### Other components

- **Members and managers**
- **Web requests**

## Connections

- Members and managers → Web requests: submit requests
- Web requests → Web entry point: enters through (evidence: `webapp/public/index.php`)
- Web entry point → Request router: dispatches to (evidence: `webapp/public/index.php`)
- Request router → Portal routes: routes portal
- Request router → API routes: routes API
- Portal routes → Authentication: checks login (evidence: `webapp/routes/portal.php`)
- Members and managers → Keycloak identity: authenticates with
- Portal routes → Member management: offers management (evidence: `webapp/routes/portal.php`)
- Portal routes → Billing: handles billing (evidence: `webapp/routes/portal.php`)
- Portal routes → EDA import: manages imports (evidence: `webapp/routes/portal.php`)
- EDA import → EDA parser: parses EDA data
- Metering ingest → Platform database: writes measurements
- Live dashboard → Platform database: reads aggregates
- Members and managers → Live dashboard: views public data
- Portal routes → Assembly records: manages assemblies
- Assembly records → PDF generation: renders documents
- Portal routes → Support tickets: handles support
- Platform control center → Keycloak identity: integrates SSO (evidence: `konsole/src/App.php`)
- Platform control center → Members and managers: serves administrators
