Skip to content

docs: add code structure section to README - #89

Merged
luca-baeck merged 3 commits into
mainfrom
docs/readme-code-structure
Jul 24, 2026
Merged

docs: add code structure section to README#89
luca-baeck merged 3 commits into
mainfrom
docs/readme-code-structure

Conversation

@okso-hub

Copy link
Copy Markdown
Member

Was

Fügt dem Frontend-README eine Code-Struktur-Sektion hinzu (zwischen Technologie-Stack und Mehr).

Warum

Macht das Frontend-Repo standalone verständlich — welcher Ordner macht was, wie fließen Daten — und dient als Grundlage für den Code-Walkthrough im Abgabe-Video.

Inhalt

  • Datenfluss als roter Faden (viewsstoresapiaxios/Bearer → Backend)
  • Verzeichnisbaum src/ mit Einzeiler pro Ordner
  • Hinweis, dass .d.ts generierte Build-Artefakte sind
  • Tabelle zentraler Mechanismen (axios-Interceptor, auth.store, useKeycloak, SSE-Stream, Router-Guards)
  • Erklärung des Deployment-Wizards und der api/ ↔ stores/-Paarung

Bewusst weggelassen: Auflistung aller 20+ Views einzeln, Architektur-Erklärungen (→ .github).

@okso-hub okso-hub self-assigned this Jul 24, 2026
@okso-hub okso-hub added the documentation Improvements or additions to documentation label Jul 24, 2026
@luca-baeck
luca-baeck merged commit 715954d into main Jul 24, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants