Entwicklerdokumentation
ChurchApps ist eine Sammlung von etwa 20 Open-Source-Projekten, die zusammen eine vollständige Gemeindeverwaltungsplattform bereitstellen. Die Projekte umfassen Backend-APIs, Web-Anwendungen, mobile Apps, eine Desktop-Anwendung und gemeinsam genutzte Bibliotheken – alle geschrieben in TypeScript. Dieser Bereich enthält alles, was Sie benötigen, um eine lokale Entwicklungsumgebung einzurichten und mit dem Mitwirken zu beginnen.
Architektur im Überblick
Die Projekte sind eigenständige Repositories (kein Monorepo). Gemeinsamer Code wird unter dem Scope @churchapps/* auf npm veröffentlicht und als normale Abhängigkeit eingebunden. Das bedeutet, dass Sie an einem einzelnen Projekt arbeiten können, ohne das gesamte Ökosystem zu klonen.
Wichtige Merkmale:
- Sprache: durchgehend TypeScript
- Backend: Node.js / Express-APIs, bereitgestellt auf AWS Lambda über das Serverless Framework
- Web: React 19 (Vite und Next.js), Material-UI 7
- Mobil: React Native mit Expo
- Datenbank: MySQL 8.0, eine Datenbank pro API-Modul
Was dieser Bereich abdeckt
- Einrichtung – Lokale Entwicklungsumgebung, Voraussetzungen und Konfiguration
- Voraussetzungen – Erforderliche Werkzeuge und Software
- Projektübersicht – Alle Projekte auf einen Blick
- Umgebungsvariablen – Konfiguration von
.env-Dateien
- API – Lokale Einrichtung der Core-API, Initialisierung der Datenbank und Modulstruktur
- Web-Apps – B1Admin, B1App und LessonsApp lokal ausführen
- Mobile Apps – Erstellen von B1Checkin und anderen Expo-Apps
- Gemeinsame Bibliotheken – Arbeiten mit Helpers, ApiHelper und AppHelper
- Bereitstellung – Bereitstellung von APIs, Web-Apps und mobilen Apps
- FreePlay-Inhaltsanbieter – Integration Ihrer Lektionsbibliothek in FreePlay
Community und Ressourcen
| Ressource | Link |
|---|---|
| GitHub-Organisation | github.com/ChurchApps |
| Issue-Tracker | ChurchAppsSupport Issues |
| Slack-Community | Slack beitreten |
Der schnellste Weg, um mitzuwirken, besteht darin, eine Web-App (z. B. B1Admin) auszuwählen, sie auf die gemeinsamen Demo-APIs auszurichten und mit Frontend-Änderungen zu beginnen. Es ist keine Datenbank- oder API-Einrichtung erforderlich.