From 33f1c0fab58f29b683fb04ccae00c0bc4e6f018f Mon Sep 17 00:00:00 2001 From: StefanMoCoAt Date: Mon, 8 Dec 2025 18:17:19 +0100 Subject: [PATCH] =?UTF-8?q?chore(MP-30):=20final=20docs=20cleanup,=20adr?= =?UTF-8?q?=20consolidation=20&=20legacy=20removal=20###=20Summary=20-=20U?= =?UTF-8?q?pdated=20root=20`README.md`=20to=20reflect=20the=20new=20Backen?= =?UTF-8?q?d/Frontend=20structure.=20=20=20-=20Rewrote=20the=20project=20s?= =?UTF-8?q?tructure=20section=20to=20show=20`backend/`=20and=20`frontend/`?= =?UTF-8?q?=20with=20their=20submodules,=20and=20`docs/adr`=20+=20`docs/c4?= =?UTF-8?q?`.=20=20=20-=20Corrected=20Gradle=20module=20examples=20from=20?= =?UTF-8?q?old=20`:members:members-service`=20paths=20to=20`:backend:servi?= =?UTF-8?q?ces:results:results-service`=20for=20both=20`bootRun`=20and=20`?= =?UTF-8?q?test`=20examples.=20=20=20-=20Verified=20links=20now=20point=20?= =?UTF-8?q?to=20`docs/adr`=20and=20`docs/c4`.=20-=20Updated=20`docs/README?= =?UTF-8?q?.md`=20to=20ensure=20flat=20paths:=20=20=20-=20Confirmed=20ADR?= =?UTF-8?q?=20and=20C4=20links=20point=20to=20`adr/`=20and=20`c4/`=20respe?= =?UTF-8?q?ctively.=20=20=20-=20Updated=20the=20footer=20note=20to=20today?= =?UTF-8?q?=E2=80=99s=20date=20and=20linked=20ADR-0009.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit These changes align the docs with the consolidated, flat documentation layout and the finalized module structure. Ref: MP-30 --- README.md | 65 ++++++++++++++++++++++++++++---------------------- docs/README.md | 4 ++-- 2 files changed, 39 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index da985a2a..307a7ce6 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ cp -n .env.template config/env/.env 2>/dev/null || true docker compose -f docker-compose.yaml up -d # 5) Services starten (Beispiel) -./gradlew :members:members-service:bootRun +./gradlew :backend:services:results:results-service:bootRun # oder – falls zentral gewollt und unterstützt # ./gradlew bootRun ``` @@ -163,33 +163,42 @@ Sicherheits-Hinweise: ```plaintext Meldestelle/ -├── 🗂️ client/ # Client-Anwendungen -│ ├── desktop-app/ -│ └── web-app/ -├── 🗂️ core/ # Gemeinsame Kern-Komponenten +├── backend/ # Backend: Gateway, Infrastruktur, Services +│ ├── infrastructure/ +│ │ ├── cache/ +│ │ ├── event-store/ +│ │ ├── gateway/ +│ │ ├── messaging/ +│ │ └── monitoring/ +│ └── services/ +│ ├── entries/ +│ ├── results/ +│ ├── scheduling/ +│ ├── ping/ +│ └── registry/ +├── frontend/ # Kotlin Multiplatform Frontend (Web/JVM) +│ ├── core/ # Shared Foundation +│ │ ├── design-system/ +│ │ ├── domain/ +│ │ ├── network/ +│ │ ├── local-db/ +│ │ └── navigation/ +│ ├── features/ # Vertikale Slices +│ │ ├── auth-feature/ +│ │ └── ping-feature/ +│ ├── shared/ +│ └── shells/ +│ └── meldestelle-portal/ +├── core/ # Gemeinsame Core-Module (JVM/KMP-unabhängig) │ ├── core-domain/ │ └── core-utils/ -├── 🗂️ docs/ # Minimale Entwickler-Dokumentation -│ ├── architecture/ -│ └── how-to/ -├── 🗂️ events/ # Bounded Context: Veranstaltungsverwaltung -│ └── (analog zu members) -├── 🗂️ horses/ # Bounded Context: Pferderegistrierung -│ └── (analog zu members) -├── 🗂️ infrastructure/ # Technische Infrastruktur -│ ├── auth/ # Authentifizierung -│ ├── cache/ # Caching (Redis) -│ ├── gateway/ # API Gateway (Spring Cloud Gateway) -│ ├── messaging/ # Kafka-Integration -│ └── monitoring/ # Observability -├── 🗂️ masterdata/ # Bounded Context: Stammdaten -│ └── (analog zu members) -└── 🗂️ members/ # Bounded Context: Mitgliederverwaltung - ├── members-api/ - ├── members-application/ - ├── members-domain/ - ├── members-infrastructure/ - └── members-service/ +├── docs/ # Repository-Dokumentation +│ ├── adr/ # Architecture Decision Records (flach) +│ ├── c4/ # C4-Diagramme (PlantUML) +│ ├── how-to/ +│ └── reference/ +├── platform/ # Versionen, BOM und Abhängigkeitsbündel +└── config/ # Runtime-/Tooling-Konfiguration ``` --- @@ -266,7 +275,7 @@ docker compose -f docker-compose.services.yaml up -d # Services via Gradle a) Einzeldienst -./gradlew :members:members-service:bootRun +./gradlew :backend:services:results:results-service:bootRun b) Falls unterstützt: alle (oder Aggregator) ./gradlew bootRun ``` @@ -292,7 +301,7 @@ b) Falls unterstützt: alle (oder Aggregator) ### Spezifisches Modul testen ```bash - ./gradlew :members:members-service:test + ./gradlew :backend:services:results:results-service:test ``` --- diff --git a/docs/README.md b/docs/README.md index 879fed66..4e0abf19 100644 --- a/docs/README.md +++ b/docs/README.md @@ -93,5 +93,5 @@ Das Projekt nutzt automatisierte Workflows für Konsistenz: --- -**Hinweis**: Diese README wurde am 30. Oktober 2025 aktualisiert im Rahmen der Documentations-Migration nach YouTrack ( -siehe ADR-0009 - folgt). +**Hinweis**: Diese README wurde am 8. Dezember 2025 aktualisiert im Rahmen der Dokumentations-Migration nach YouTrack +(siehe [ADR-0009](adr/0009-final-kmp-architecture.md)).