StefanMoCoAt 5cc1ee6e4d docs: erweitere Makefile-Dokumentation in README und start-local (MP-17) (#17 )

Integriert umfassende Makefile-Referenz in die Haupt-Dokumentation für
bessere Auffindbarkeit und Developer Experience.

Änderungen:
- README.md: Erweitert "Makefile-Shortcuts" zu "Makefile-Befehle"
  - Hinzugefügt: Wichtigste Development-Befehle (full-up, services-up, dev-up, test, health-check)
  - Hinzugefügt: SSoT-Befehle (docker-sync, docker-compose-gen, docker-validate)
  - Hinzugefügt: Link zur vollständigen Referenz in docker-development.md
  - +20 Zeilen (Zeilen 292-319)

- docs/how-to/start-local.md: Neue Sektion "Weitere Makefile-Befehle"
  - Hinzugefügt: Verweis auf `make help`
  - Hinzugefügt: Link zu Docker Development Guide Makefile-Referenz
  - +6 Zeilen (nach Zeile 39)

Kontext:
Diese Änderungen bauen auf der vollständigen Makefile-Dokumentation in
.junie/guidelines/technology-guides/docker/docker-development.md auf
(194 → 756 Zeilen, 50+ Befehle, erstellt am 2025-11-11).

Nutzen:
- Entwickler: Schnellerer Einstieg durch zentrale Übersicht
- Onboarding: Alle wichtigen Befehle auf einen Blick
- AI-Assistenten: Konsistente Command-Referenz
- Dokumentation: Verbesserte Navigation zwischen How-To-Guides und Referenz

Technische Details:
Das Makefile umfasst 10 Befehlskategorien:
1. Development Workflow (dev-up, dev-down, dev-restart, dev-logs, dev-info)
2. Layer-spezifisch (infrastructure-*, services-*, clients-*)
3. Full System (full-up, full-down, full-restart, full-logs)
4. Build (build, build-service, build-client)
5. Test (test, test-e2e)
6. Environment (env-setup, env-dev, env-prod, env-staging, env-test, validate)
7. SSoT (versions-show, versions-update, docker-sync, docker-compose-gen, docker-validate, hooks-install)
8. Production (prod-up, prod-down, prod-restart, prod-logs)
9. Monitoring (status, health-check, logs, shell)
10. Cleanup (clean, clean-all)

Related:
- Vorherige Commits: Makefile-Optimierung (425 Zeilen, strukturiert)
- Vorherige Commits: docker-development.md vollständige Aktualisierung
- Vorherige Commits: Port-Korrekturen (8080 → 8081)

Testing:
- ✅ make help zeigt alle Befehle korrekt an
- ✅ Links in Markdown funktionieren
- ✅ Dokumentation konsistent mit aktuellem Makefile

2025-11-11 23:32:40 +01:00

2.2 KiB

Raw Blame History

owner	status	review_cycle	last_reviewed	summary	bc	doc_type
project-maintainers	active	90d	2025-10-15	Kürzeste Anleitung, um das komplette System lokal zu starten und zu prüfen, ob alles läuft.	infrastructure	how-to

How-To: Lokale Umgebung starten (Quickstart)

Diese Kurz-Anleitung bringt deine lokale Umgebung in wenigen Minuten zum Laufen.

Starten

Komplettes System (Infra + Services + Clients)

make full-up

Nur Backend (Infra + Gateway + Microservices)

make services-up

Nur Clients (Infra + Web-App)

make clients-up

Logs ansehen (z. B. Backend):

make services-logs

Weitere Makefile-Befehle

Für eine vollständige Liste aller verfügbaren Befehle siehe:

make help (im Terminal)
Docker Development Guide

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

# 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 sind nicht erreichbar → Container 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 (8082–8086).
Port-Kollisionen → Belegte Ports mit lsof -i :PORT prüfen oder Ports anpassen.

Stoppen

 make full-down
 # oder spezifisch: 
 make services-down 
 make clients-down 
 make infrastructure-down

2.2 KiB Raw Blame History Unescape Escape