Auf einen Blick

Commit-Konventionen

<type>(optional scope)[!]: <Kurzbeschreibung>

Komponenten:

type: Art der Änderung (z. B. feat, fix, docs, chore)
scope (optional): Bereich/Modul, z. B. (ui) oder (api)
! (optional): Bricht die Rückwärtskompatibilität – erfordert Major-Release
Kurzbeschreibung: Imperativer Satz ohne Punkt

Beispiel:

feat(ui): Button-Komponente hinzufügen

Häufigste Typen

feat – neue Funktionen
fix – Fehlerbehebungen
docs – Dokumentation
style – Formatierung (kein Code-Change)
refactor – Code-Umstrukturierung (keine Funktion)
test – Tests hinzufügen/ändern
chore – Wartung, Build-Skripte, Abhängigkeiten

Warum nutzen?

Automatik: Changelogs & Versionen lassen sich automatisch erzeugen
Klarheit: Einheitliche, gut lesbare Commit-Historie
Onboarding: Neue Entwickler verstehen schnell, was passiert

Beispiel:

git commit -m "fix(api): NullPointer bei ungültigen Eingaben verhindern"

DB-Connect

Connection String

Die Connection-Daten müssen in einer Datei /api/.env gespeichert werden. Diese Datei ist nicht im Repo (.gitignore). Ein Beispiel einer .env:

DB_HOST=localhost
DB_NAME=fulda
DB_USER=root
DB_PASSWORD=root

User-Verwaltung

Um die Datenbank für die User-Verwaltung vorzubereiten, muss zunächst die entsprechende Migration durchgeführt werden. Diese stellt sicher, dass alle benötigten Tabellen existieren.

Grundvoraussetzung

Das dotnet-ef Tool ist bereits für das API-Projekt hinzugefügt. Eine globale Installation ist damit nicht zwingend notwendig.

Anwenden von Migrationen

Um die Migrationen auszuführen, muss folgender Befehl in der Kommandozeile, im Order /api, ausgeführt werden. Damit werden alle Migrationen angewandt.

dotnet ef database update

JWT

Für das Login wird ein JWT (JSON Web Token) verwendet. Für diesen müssen in der .env drei Variablen abgespeicehrt werden. Gerade das Prod-Secret sollte nirgendwo anders ebenfalls verwendet werden.

.env-Datei mit DB und JWT:

DB_HOST=localhost
DB_NAME=fulda
DB_USER=root
DB_PASSWORD=root
JWT_SECRET=jUUzhf7&&67dhsj0oJH65DFt522gKCMu
JWT_ISSUER=fulda-api
JWT_AUDIENCE=fulda-client