shinkan-jinkendo/docs/architecture/README.md
Lars e759076a6c
All checks were successful
Deploy Development / deploy (push) Successful in 41s
Test Suite / pytest-backend (push) Successful in 40s
Test Suite / lint-backend (push) Successful in 0s
Test Suite / build-frontend (push) Successful in 13s
Test Suite / k6 /health Baseline (push) Successful in 33s
Test Suite / playwright-tests (push) Successful in 1m8s
chore(version): update version and changelog for release 0.8.136
- Bumped APP_VERSION to 0.8.136 and updated the changelog to reflect recent changes.
- Fixed the Mandanten-Header handling in `api/exercises.js` for improved API requests.
- Continued Frontend Phase 4 with the addition of the `exercises.js` module, enhancing the API structure.
- Updated architecture documentation to include details on the new `exercises.js` API and its integration with the existing client structure.
- Enhanced `utils/api.js` to re-export the new exercises module, streamlining API access.
2026-05-14 21:49:56 +02:00

2.6 KiB
Raw Blame History

Architektur: Zielbild, Refaktor, Regeln (Shinkan Jinkendo)

Dieses Bündel ist die Leitlinie für die große Refaktorierung nach dem MVP. Es ergänzt die bestehenden Pflichtdokumente (.claude/rules/ARCHITECTURE.md, CODING_RULES.md, Zugriffsschicht, Media-Spec) und ist für Wartbarkeit, Performance und sichere Erweiterung verbindlich, soweit hier ausdrücklich festgelegt.

Inhalt

Datei Zweck
ZIELBILD_ARCHITEKTUR.md Zielarchitektur (Frontend, API, Daten), Qualitätsziele, Einbindung neuer Features
SCHULDEN_UND_REMEDIATION.md Erfasste Architekturschuld, Reihenfolge und Massnahmen zur Behebung
UMSETZUNGSPLAN_ROADMAP.md Phasen, Meilensteine, Abnahmekriterien, Aufwandsschwerpunkte
frontend/src/api/client.js Phase 4: zentraler HTTP-Client (request, ACTIVE_CLUB_STORAGE_KEY, API_URL, mergeActiveClubHeader)
frontend/src/api/exercises.js Phase 4: Übungen, Medien/Archiv, Progressionsgraphen, KI-Hilfen
frontend/src/api/planning.js Phase 4: Trainingsplanung (Einheiten, Vorlagen, Module, Rahmen, KPIs)
BASELINE_SNAPSHOT.md Phase 0: Bundle-, API- und Last-Baseline (Messvorlagen, Vergleich nach Phase 2)
VERBINDLICHE_REGELN_SHINKAN.md Verbindliche Shinkan-spezifische Regeln (Ergänzung zu den globalen Rules)

Tests (E2E / Refaktor-Budget)

  • tests/dev-smoke-test.spec.js Playwright-Suite (Smoke + Compliance). Enthält u. a. Test 8: nach Login und Reload des Dashboards werden GET-Aufrufe zu /api/profiles/me und /api/training-units gezählt (Absicherung Dashboard-Refaktor Phase 1). Ausführung: npm run test:e2e; CI: .gitea/workflows/test.yml Job playwright-tests. k6-Baseline: Job k6-health-baseline (siehe scripts/load/README.md).

Pflege

  • Bei abgeschlossenen Phasen: Roadmap und Remediation-Dokument aktualisieren; bei Regeländerungen: nur mit expliziter Projektfreigabe (gleiches Verfahren wie bei .claude/rules/ARCHITECTURE.md).
  • Querschnitt: docs/HANDOVER.md soll auf die aktive Roadmap-Phase verweisen.

Bezug MVP

Die aktuelle Codebasis ist funktional MVP-tauglich; strukturell bestehen bekannte Schwerpunkte (grosse Seiten-Monolithen, API-Monolith im Client, redundante Lesepfade, schwere Listenqueries). Dieses Bündel definiert, wie nach dem MVP weitergebaut wird, ohne jedes neue Feature erneut mit architektonischer Schuld zu überfrachten.