Stefan Mogeritsch
a454e6c97a
Implemented a standardized folder structure for domain documentation to improve clarity and maintainability. Migrated existing files to the new structure, updated links in related documentation, and added README files for navigation and guidance.
42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
# Meldestelle
|
||
|
||
> Modulares System für Pferdesportveranstaltungen mit Domain-Driven Design, Kotlin Multiplatform und Microservices.
|
||
|
||
[](https://github.com/StefanMoCoAt/meldestelle/actions)
|
||
[](https://opensource.org/licenses/MIT)
|
||
|
||
---
|
||
|
||
## 📚 Dokumentation: Die einzige Quelle der Wahrheit
|
||
|
||
Die gesamte Projekt-Dokumentation – von der Architektur über die fachliche Domäne bis hin zu den Entwickler-Anleitungen – befindet sich im `/docs` Verzeichnis.
|
||
|
||
**Starte hier:**
|
||
### [**-> docs/README.md**](./docs/README.md)
|
||
|
||
---
|
||
|
||
## 🚀 Quick Start
|
||
|
||
Diese Befehle starten die Kern-Infrastruktur und die Services.
|
||
|
||
```bash
|
||
# 1. Umgebungsvariablen vorbereiten (nur beim ersten Mal)
|
||
cp .env.example .env
|
||
|
||
# 2. Gesamtes System mit Docker Compose starten
|
||
docker compose up -d
|
||
```
|
||
|
||
Für detailliertere Anleitungen, wie z.B. das Starten einzelner Services oder das Frontend-Setup, siehe die **[-> Lokale Setup-Anleitung](./docs/02_Onboarding/start-local.md)**.
|
||
|
||
---
|
||
|
||
## 🤝 Contributing
|
||
|
||
Beiträge sind willkommen. Bitte beachte unseren [**-> Branch- und PR-Workflow**](./docs/02_Onboarding/branchschutz-und-pr-workflow.md).
|
||
|
||
## 📜 Lizenz
|
||
|
||
Dieses Projekt steht unter der [MIT License](LICENSE).
|