Zum Hauptinhalt springen

B1 Admin

B1Admin ist das Verwaltungs-Dashboard der Kirche -- eine React-Single-Page-Anwendung, die mit Vite und Material-UI erstellt wurde. Kirchenmitarbeiter nutzen sie, um Personen, Gruppen, Anwesenheit, Spenden, Inhalte und mehr zu verwalten.

Bevor Sie beginnen

Einrichtung​

1. Das 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-Endpunkte. Sie können sie auf die gemeinsame Demo-API (https://api.demo.churchapps.org) oder auf Ihre lokale API-Instanz richten. Die Beispieldatei enthält möglicherweise noch ausgemusterte Staging-URLs; ersetzen Sie diese.

4. Den Entwicklungsserver starten​

npm start

Dadurch wird der Vite-Entwicklungsserver gestartet. Die App ist anschließend in Ihrem Browser verfügbar, mit aktiviertem Hot Module Replacement.

Wichtige Umgebungsvariablen​

VariableBeschreibung
REACT_APP_STAGEName der Umgebung (z. B. demo wie in der Beispieldatei, prod oder selfhost)
PORTPort des Entwicklungsservers (Standard: 3101)
REACT_APP_*_APIAPI-Endpunkt-URLs für jedes Modul
Info

Das Skript postinstall kopiert Sprach- und CSS-Dateien aus @churchapps/apphelper. Wenn Komponenten ohne Gestaltung erscheinen, führen Sie npm run postinstall manuell aus.

Wichtige Befehle​

BefehlBeschreibung
npm startVite-Entwicklungsserver starten
npm run buildProduktionsbuild über Vite
npm run testEnd-to-End-Tests mit Playwright ausführen
npm run lintESLint mit automatischer Korrektur ausführen

Technologie-Stack​

  • React 19 mit TypeScript
  • Vite für Build-Werkzeuge und Entwicklungsserver
  • Material-UI 7 für UI-Komponenten
  • React Query 5 für den Serverzustand
  • @churchapps/apphelper*-Pakete für gemeinsam genutzte Komponenten

Bereitstellung​

Produktionsbuilds werden auf S3 + CloudFront bereitgestellt:

  1. npm run build erzeugt statische Assets
  2. Die Assets werden in einen S3-Bucket synchronisiert
  3. Eine CloudFront-Invalidierung wird ausgelöst, damit die neue Version ausgeliefert wird
Tipp

Ausführliche Bereitstellungsanweisungen finden Sie im Leitfaden Web-App-Bereitstellung.