refactoring Dokumentation

This commit is contained in:
2025-10-15 12:48:00 +02:00
parent e8f33e465c
commit be464f2ac0
42 changed files with 1155 additions and 13101 deletions
+67
View File
@@ -0,0 +1,67 @@
---
owner: project-maintainers
status: active
review_cycle: 90d
last_reviewed: 2025-10-15
summary: Kürzeste Anleitung, um das komplette System lokal zu starten und zu prüfen, ob alles läuft.
---
# How-To: Lokale Umgebung starten (Quickstart)
Diese Kurz-Anleitung bringt deine lokale Umgebung in wenigen Minuten zum Laufen.
## Starten
- Komplettes System (Infra + Services + Clients)
```bash
make full-up
```
- Nur Backend (Infra + Gateway + Microservices)
```bash
make services-up
```
- Nur Clients (Infra + Web-App)
```bash
make clients-up
```
Logs ansehen (z. B. Backend):
```bash
make services-logs
```
## Wichtige URLs
- Web App: http://localhost:4000
- API Gateway: http://localhost:8081 (Health: /actuator/health)
- Keycloak (Auth): http://localhost:8180
- Consul (Service Discovery): http://localhost:8500
Weitere Ports findest du unter: reference/ports-and-urls.md
## Health-Checks
```bash
# Gateway
curl -i http://localhost:8081/actuator/health
# Web-App (falls vorhanden)
curl -i http://localhost:4000/health || true
```
## Auth (Keycloak)
- Admin-Login (default): http://localhost:8180
- Username: KC_BOOTSTRAP_ADMIN_USERNAME (default: admin)
- Password: KC_BOOTSTRAP_ADMIN_PASSWORD (default: admin)
- Beim ersten Start wird der Realm aus docker/services/keycloak/meldestelle-realm.json importiert.
## Häufige Probleme
- Dienste nicht erreichbar → Containers laufen? `make full-logs` bzw. `make services-logs` prüfen.
- 401/403 beim API-Aufruf → Prüfen, ob ein gültiges Bearer-Token gesendet wird und Keycloak erreichbar ist.
- CORS im Browser → API über das Gateway (http://localhost:8081) aufrufen und nicht direkt die Services (80828086).
- Port-Kollisionen → Belegte Ports mit `lsof -i :PORT` prüfen oder Ports anpassen.
## Stoppen
```bash
make full-down
# oder spezifisch: make services-down / make clients-down / make infrastructure-down
```