Lars/shinkan-jinkendo
1
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases 3 Wiki Activity
8f5af49a6f
shinkan-jinkendo/docs/architecture
History
Lars 8f5af49a6f
All checks were successful
Deploy Development / deploy (push) Successful in 38s
Details
Test Suite / pytest-backend (push) Successful in 36s
Details
Test Suite / lint-backend (push) Successful in 0s
Details
Test Suite / build-frontend (push) Successful in 12s
Details
Test Suite / k6 /health Baseline (push) Successful in 34s
Details
Test Suite / playwright-tests (push) Successful in 1m21s
Details
chore(version): update version and changelog for release 0.8.133 
- Bumped APP_VERSION to 0.8.133 and updated the changelog to reflect recent changes.
- Initiated Frontend Phase 4 Welle 1, introducing a centralized HTTP client in `frontend/src/api/client.js` while maintaining `utils/api.js` as a facade.
- Documented the changes in the architecture roadmap and README for clarity on the new API structure.
2026-05-14 21:31:04 +02:00
..
BASELINE_SNAPSHOT.md chore(version): update version and changelog for release 0.8.131 2026-05-14 16:02:54 +02:00
README.md chore(version): update version and changelog for release 0.8.133 2026-05-14 21:31:04 +02:00
SCHULDEN_UND_REMEDIATION.md feat(docs): add performance baseline documentation and update architecture references 2026-05-14 06:53:37 +02:00
UMSETZUNGSPLAN_ROADMAP.md chore(version): update version and changelog for release 0.8.133 2026-05-14 21:31:04 +02:00
VERBINDLICHE_REGELN_SHINKAN.md feat(docs): update architecture documentation references and enhance handover details 2026-05-14 06:42:13 +02:00
ZIELBILD_ARCHITEKTUR.md feat(docs): update architecture documentation references and enhance handover details 2026-05-14 06:42:13 +02:00

README.md

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); utils/api.js bleibt Facade
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.