Lokale API-Einrichtung
Diese Anleitung führt Sie durch die lokale Einrichtung der ChurchApps-API für die Entwicklung. Sie klonen das Repository, konfigurieren die Datenbankverbindungen, initialisieren das Schema und starten den Entwicklungsserver mit Hot Reload.
Bevor Sie beginnen
- Installieren Sie Node.js 24+, Git und MySQL 8.0+ -- siehe Voraussetzungen
- Erstellen Sie einen MySQL-Benutzer mit der Berechtigung, Datenbanken anzulegen
- Lesen Sie die Referenz Umgebungsvariablen für die API-Konfiguration
Schritt für Schritt
1. Repository klonen
git clone https://github.com/ChurchApps/Api.git
2. Abhängigkeiten installieren
Das Projekt verwendet Yarn (eine Schutzregel blockiert npm install):
cd Api
yarn install
3. Umgebungsvariablen konfigurieren
cp .env.sample .env
Öffnen Sie .env und konfigurieren Sie Ihre MySQL-Verbindungszeichenfolgen. Jedes Modul benötigt eine eigene Datenbankverbindung im folgenden Format:
mysql://root:password@localhost:3306/dbname
Sie benötigen Verbindungszeichenfolgen für alle sechs Moduldatenbanken (membership, attendance, content, giving, messaging, doing).
4. Datenbanken initialisieren
npm run initdb
Dies erstellt automatisch alle sechs Datenbanken und ihre Tabellen.
Sie können die Datenbank eines einzelnen Moduls mit npm run initdb -- --module=membership initialisieren (oder mit attendance, content, giving, messaging, doing).
5. Entwicklungsserver starten
npm run dev
Die API startet mit Hot Reload unter http://localhost:8084.
Wichtige Befehle
| Befehl | Beschreibung |
|---|---|
npm run dev | Entwicklungsserver mit Hot Reload starten (tsx watch) |
npm run build | Bereinigen, TypeScript kompilieren und Assets kopieren |
npm run test | Tests mit Jest ausführen (inklusive Coverage) |
npm run test:watch | Tests im Watch-Modus ausführen |
npm run lint | ESLint mit automatischer Korrektur ausführen (ESLint ist der alleinige Formatierer) |
Bereitstellung
Die Staging-Umgebung wurde außer Betrieb genommen. Die API wird bei jedem Push auf main in die Demo-Umgebung bereitgestellt und über den manuell auszulösenden Workflow Deploy Prod in die Produktion, der außerdem ausstehende Datenbankmigrationen anwendet. Details finden Sie unter API-Bereitstellung.
Lokale Bibliotheksentwicklung
Wenn Sie eine gemeinsam genutzte Bibliothek (@churchapps/helpers oder @churchapps/apihelper) zusammen mit der API entwickeln möchten, erstellen Sie sie im Arbeitsbereich Packages und fügen Sie in der API ein temporäres Yarn-Portal hinzu:
# Im Packages-Arbeitsbereich
yarn build
# Im API-Verzeichnis
yarn link ../Packages/helpers
# ... testen ...
yarn unlink ../Packages/helpers && yarn install
So können Sie Änderungen an der Bibliothek testen, ohne sie auf npm zu veröffentlichen. Weitere Informationen finden Sie unter Gemeinsam genutzte Bibliotheken -- und committen Sie niemals die Portal-Auflösung, die der Link in package.json schreibt.
Verwandte Artikel
- Datenbank -- Die Architektur mit einer Datenbank pro Modul verstehen
- Modulstruktur -- Wie Controller, Repositories und Modelle organisiert sind
- Gemeinsam genutzte Bibliotheken -- Arbeiten mit
@churchapps/helpersund@churchapps/apihelper