Lars/shinkan-jinkendo
1
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases 3 Wiki Activity
255fa45e90
shinkan-jinkendo/docs/architecture/README.md
Lars 255fa45e90
All checks were successful
Deploy Development / deploy (push) Successful in 40s
Details
Test Suite / pytest-backend (push) Successful in 35s
Details
Test Suite / lint-backend (push) Successful in 0s
Details
Test Suite / build-frontend (push) Successful in 11s
Details
Test Suite / playwright-tests (push) Successful in 57s
Details
feat(tests): add E2E test for Dashboard API budget and update documentation 
- Introduced a new E2E test to validate API call counts for `/api/profiles/me` and `/api/training-units` after reloading the Dashboard, ensuring compliance with refactor phase requirements.
- Updated architecture documentation to include details about the new test and its execution within the CI pipeline.
2026-05-14 06:49:15 +02:00

2.0 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
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.

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.