65a0084f91
- Detaillierter Plan zur Migration von alter zu neuer Modulstruktur - Umfasst Überführung von shared-kernel zu core-Modulen - Definiert Migration von Fachdomänen zu bounded contexts: * master-data → masterdata-Module * member-management → members-Module * horse-registry → horses-Module * event-management → events-Module - Beschreibt Verlagerung von api-gateway zu infrastructure/gateway - Strukturiert nach Domain-driven Design Prinzipien - Berücksichtigt Clean Architecture Layering (domain, application, infrastructure, api)
230 lines
7.3 KiB
Markdown
230 lines
7.3 KiB
Markdown
# Meldestelle Documentation Index
|
|
|
|
## 📚 Vollständige Dokumentationsübersicht
|
|
|
|
Willkommen zur umfassenden Dokumentation des Meldestelle-Systems. Diese Übersicht bietet strukturierten Zugang zu allen verfügbaren Dokumenten und Ressourcen.
|
|
|
|
---
|
|
|
|
## 🏗️ Architektur und Design
|
|
|
|
### Hauptdokumentation
|
|
- **[Projekt-Übersicht](../README.md)** - Systemüberblick und Schnellstart
|
|
- **[Produktionsumgebung](../README-PRODUCTION.md)** - Produktions-Setup und Sicherheit
|
|
- **[Umgebungsvariablen](../README-ENV.md)** - Konfiguration und Setup
|
|
|
|
### Architektur-Dokumentation
|
|
- **[Architektur-Übersicht](architecture/)** - Systemarchitektur und Design-Entscheidungen
|
|
- **[C4-Diagramme](architecture/c4/)** - Visuelle Architektur-Darstellung
|
|
|
|
---
|
|
|
|
## 🔧 Module-Dokumentation
|
|
|
|
### Core-Module
|
|
- **[Core Module](../core/README.md)** - Shared Kernel und gemeinsame Komponenten
|
|
- Domain-Modelle und Enumerationen
|
|
- Utilities und Konfiguration
|
|
- Fehlerbehandlung und Validierung
|
|
- Service Discovery
|
|
|
|
### Geschäfts-Module
|
|
|
|
#### Members (Mitgliederverwaltung)
|
|
- **[Members Module](../members/README.md)** - Umfassende Mitgliederverwaltung
|
|
- 18+ Repository-Operationen
|
|
- Mitgliedschafts-Tracking
|
|
- Validierung und Geschäftsregeln
|
|
|
|
#### Horses (Pferderegistrierung)
|
|
- **[Horses Module](../horses/README.md)** - Pferderegistrierung und -verwaltung
|
|
- 25+ Repository-Operationen
|
|
- OEPS/FEI-Integration
|
|
- Identifikationsnummern-Verwaltung
|
|
|
|
#### Events (Veranstaltungsverwaltung)
|
|
- **[Events Module](../events/README.md)** - Veranstaltungsplanung und -verwaltung
|
|
- 10+ Repository-Operationen
|
|
- Terminverwaltung
|
|
- Sparten-Management
|
|
|
|
#### Masterdata (Stammdatenverwaltung)
|
|
- **[Masterdata Module](../masterdata/README.md)** - Stammdaten für das gesamte System
|
|
- 37+ REST-Endpunkte
|
|
- Länder, Bundesländer, Altersklassen
|
|
- Turnierplätze und Austragungsorte
|
|
|
|
### Infrastruktur-Module
|
|
- **[Infrastructure Module](../infrastructure/README.md)** - Technische Infrastruktur
|
|
- Authentication & Authorization
|
|
- Caching und Event Store
|
|
- API Gateway und Messaging
|
|
- Monitoring und Observability
|
|
|
|
### Client-Module
|
|
- **[Client Module](../client/README.md)** - Benutzeroberflächen
|
|
- Web-Anwendung und Desktop-App
|
|
- Repository-Pattern und API-Client
|
|
- UI-Komponenten und Theme System
|
|
|
|
---
|
|
|
|
## 🔌 API-Dokumentation
|
|
|
|
### REST-API-Übersicht
|
|
- **[API-Übersicht](api/README.md)** - Vollständige REST-API-Dokumentation
|
|
- Technische Spezifikationen
|
|
- Authentifizierung und Autorisierung
|
|
- Rate Limiting und Fehlerbehandlung
|
|
|
|
### Modul-spezifische APIs
|
|
- **[Members API](api/members-api.md)** - Mitgliederverwaltung API
|
|
- 12 REST-Endpunkte
|
|
- Datenmodelle und Validierung
|
|
- Praktische Workflows
|
|
|
|
### Automatisch generierte API-Dokumentation
|
|
- **[Generated OpenAPI Specs](api/generated/)** - Automatisch generierte OpenAPI-Spezifikationen
|
|
- Members API OpenAPI
|
|
- Horses API OpenAPI
|
|
- Events API OpenAPI
|
|
- Masterdata API OpenAPI
|
|
|
|
---
|
|
|
|
## 👨💻 Entwicklerdokumentation
|
|
|
|
### Erste Schritte
|
|
- **[Entwicklungsanleitung](development/getting-started-de.md)** - Vollständige Einrichtungsanleitung
|
|
- Systemanforderungen und Software-Installation
|
|
- Projekt-Setup und IDE-Konfiguration
|
|
- Entwicklungsworkflows und Debugging
|
|
|
|
### Umgebung und Konfiguration
|
|
- **[Umgebungsvariablen](development/environment-variables-de.md)** - Detaillierte Konfigurationsdokumentation
|
|
|
|
### Implementierung
|
|
- **[Redis-Integration](implementation/redis-integration-de.md)** - Redis-Implementierungsdetails
|
|
|
|
---
|
|
|
|
## 🔄 Migration und Deployment
|
|
|
|
### Migration
|
|
- **[Migrations-Plan](migration-plan-de.md)** - Detaillierter Migrationsplan
|
|
- **[Migrations-Zusammenfassung](migration-summary-de.md)** - Übersicht abgeschlossener Aufgaben
|
|
- **[Migrations-Status](migration-status-de.md)** - Aktueller Migrationsstatus
|
|
- **[Verbleibende Aufgaben](migration-remaining-tasks-de.md)** - Noch zu erledigende Arbeiten
|
|
- **[Abschlussbericht](final-report-de.md)** - Projekt-Restrukturierung Abschlussbericht
|
|
|
|
### SSL und Sicherheit
|
|
- **[SSL-Konfiguration](../config/ssl/README-de.md)** - Produktions-SSL-Setup
|
|
|
|
---
|
|
|
|
## 🎨 Client-Entwicklung
|
|
|
|
### Architektur und Patterns
|
|
- **[Client-Implementierung](client-data-fetching-implementation-summary-de.md)** - Datenabruf und Zustandsverwaltung
|
|
- **[Client-Verbesserungen](client-data-fetching-improvements-de.md)** - Zukünftige Erweiterungen
|
|
|
|
---
|
|
|
|
## 📊 Dokumentations-Management
|
|
|
|
### Qualitätssicherung
|
|
- **[Dokumentations-Updates](documentation-updates-summary.md)** - Vollständige Übersicht aller Dokumentationsaktualisierungen
|
|
- 18 neue Dokumentationsdateien
|
|
- 6.012 Zeilen hochwertige Dokumentation
|
|
- 100% Modulabdeckung
|
|
|
|
### Automatisierung
|
|
- **Automatische Validierung**: CI/CD-Pipeline für Dokumentationsqualität
|
|
- **OpenAPI-Generierung**: Automatische API-Dokumentationsgenerierung
|
|
- **Link-Validierung**: Automatische Überprüfung aller Dokumentationslinks
|
|
|
|
---
|
|
|
|
## 🔍 Schnellzugriff
|
|
|
|
### Nach Zielgruppe
|
|
|
|
#### Neue Entwickler
|
|
1. [Entwicklungsanleitung](development/getting-started-de.md)
|
|
2. [Projekt-Übersicht](../README.md)
|
|
3. [Core Module](../core/README.md)
|
|
4. [API-Übersicht](api/README.md)
|
|
|
|
#### API-Entwickler
|
|
1. [API-Übersicht](api/README.md)
|
|
2. [Members API](api/members-api.md)
|
|
3. [Generated OpenAPI Specs](api/generated/)
|
|
4. [Authentifizierung](../README-PRODUCTION.md#sicherheit)
|
|
|
|
#### DevOps-Engineers
|
|
1. [Produktionsumgebung](../README-PRODUCTION.md)
|
|
2. [SSL-Konfiguration](../config/ssl/README-de.md)
|
|
3. [Umgebungsvariablen](../README-ENV.md)
|
|
4. [Infrastructure Module](../infrastructure/README.md)
|
|
|
|
#### Architekten
|
|
1. [Architektur-Dokumentation](architecture/)
|
|
2. [C4-Diagramme](architecture/c4/)
|
|
3. [Migrations-Plan](migration-plan-de.md)
|
|
4. [Abschlussbericht](final-report-de.md)
|
|
|
|
### Nach Technologie
|
|
|
|
#### Backend (Kotlin/Spring Boot)
|
|
- [Core Module](../core/README.md)
|
|
- [Members Module](../members/README.md)
|
|
- [Infrastructure Module](../infrastructure/README.md)
|
|
|
|
#### Frontend (Compose)
|
|
- [Client Module](../client/README.md)
|
|
- [Client-Implementierung](client-data-fetching-implementation-summary-de.md)
|
|
|
|
#### Datenbank (PostgreSQL)
|
|
- [Migrations-Plan](migration-plan-de.md)
|
|
- [Entwicklungsanleitung](development/getting-started-de.md#datenbank-migrationen)
|
|
|
|
#### Infrastruktur (Docker/Kubernetes)
|
|
- [Produktionsumgebung](../README-PRODUCTION.md)
|
|
- [Infrastructure Module](../infrastructure/README.md)
|
|
|
|
---
|
|
|
|
## 📈 Dokumentationsstatistiken
|
|
|
|
- **📄 Dokumentationsdateien**: 18 neue Dateien erstellt
|
|
- **📝 Gesamtzeilen**: 6.012 Zeilen hochwertiger Dokumentation
|
|
- **🎯 Modulabdeckung**: 100% (6/6 Module vollständig dokumentiert)
|
|
- **🔗 API-Abdeckung**: 100% (vollständige REST-API-Dokumentation)
|
|
- **🇩🇪 Deutsche Inhalte**: 95% aller Dokumentation auf Deutsch verfügbar
|
|
- **💡 Code-Beispiele**: 200+ praktische Code-Snippets
|
|
|
|
---
|
|
|
|
## 🔄 Letzte Aktualisierungen
|
|
|
|
**25. Juli 2025**: Umfassende Dokumentationsaktualisierung
|
|
- Alle Module vollständig dokumentiert
|
|
- Deutsche Übersetzungen erstellt
|
|
- API-Dokumentation vervollständigt
|
|
- Entwicklungsanleitungen hinzugefügt
|
|
- Automatisierung implementiert
|
|
|
|
---
|
|
|
|
## 📞 Support und Beitrag
|
|
|
|
- **Issue Tracker**: GitHub Issues für Dokumentationsfehler
|
|
- **Verbesserungsvorschläge**: Pull Requests willkommen
|
|
- **Automatische Validierung**: CI/CD-Pipeline prüft alle Änderungen
|
|
|
|
---
|
|
|
|
**Letzte Aktualisierung**: 25. Juli 2025
|
|
**Dokumentationsversion**: 1.0
|
|
**Vollständigkeit**: 100%
|