Zum Hauptinhalt springen

B1 Admin

B1Admin ist das Kirchenverwaltungs-Dashboard — eine React Single-Page-Anwendung gebaut mit Vite und Material-UI. Kirchenmitarbeiter nutzen sie zur Verwaltung von Personen, Gruppen, Anwesenheit, Spenden, Content und mehr.

Vor dem Start

Setup

1. Repository klonen

git clone https://github.com/ChurchApps/B1Admin.git

2. Abhängigkeiten installieren

cd B1Admin
npm install

3. Umgebungsvariablen konfigurieren

cp dotenv.sample.txt .env

Öffnen Sie .env und konfigurieren Sie die API-Endpoints. Sie können sie entweder auf die Staging-API oder Ihre lokale API-Instanz zeigen lassen.

4. Dev-Server starten

npm start

Dies startet den Vite-Dev-Server. Die App wird in Ihrem Browser mit Hot-Modul-Replacement verfügbar sein.

Wichtige Umgebungsvariablen

VariableBeschreibung
REACT_APP_STAGEUmgebungsname (z.B., local, staging, prod)
PORTDev-Server-Port (Standard: 3101)
REACT_APP_*_APIAPI-Endpoint-URLs für jedes Modul
Info

Das postinstall-Skript kopiert Locale- und CSS-Dateien von @churchapps/apphelper. Wenn Komponenten unstyled aussehen, führen Sie npm run postinstall manuell aus.

Wichtige Befehle

BefehlBeschreibung
npm startVite-Dev-Server starten
npm run buildProduction-Build via Vite
npm run testEnd-to-End-Tests mit Playwright ausführen
npm run lintESLint mit Auto-Fix ausführen

Tech-Stack

  • React 19 mit TypeScript
  • Vite für Build-Tools und Dev-Server
  • Material-UI 7 für UI-Komponenten
  • React Query 5 für Server-State
  • @churchapps/apphelper*-Packages für gemeinsame Komponenten

Deployment

Production-Builds sind zu S3 + CloudFront deployed:

  1. npm run build generiert statische Assets
  2. Assets werden zu einem S3-Bucket synced
  3. CloudFront-Invalidation wird ausgelöst, um die neue Version zu servieren
Tipp

Für detaillierte Deployment-Anweisungen, siehe Web-App-Deployment-Leitfaden.