Documentatie voor ontwikkelaars
ChurchApps is een verzameling van ongeveer 20 open-source projecten die samen een compleet kerkbeheersysteem bieden. De projecten omvatten backend API's, webtoepassingen, mobiele apps, een desktopaplicatie en gedeelde bibliotheken -- allemaal geschreven in TypeScript. Dit gedeelte biedt alles wat u nodig hebt om een lokale ontwikkelingsomgeving in te stellen en bij te dragen.
Architectuur in een oogopslag
De projecten zijn onafhankelijke repositories (geen monorepo). Gedeelde code wordt naar npm onder het bereik @churchapps/* gepubliceerd en gebruikt als normale afhankelijkheden. Dit betekent dat u aan één project kunt werken zonder het hele ecosysteem te klonen.
Belangrijke kenmerken:
- Taal: TypeScript overal
- Backend: Node.js / Express-API's geïmplementeerd op AWS Lambda via Serverless Framework
- Web: React 19 (Vite en Next.js), Material-UI 7
- Mobiel: React Native met Expo
- Database: MySQL 8.0, één database per API-module
Wat dit gedeelte behandelt
- Instellen -- Lokale ontwikkelingsomgeving, vereisten en configuratie
- Vereisten -- Vereiste tools en software
- Projectoverzicht -- Alle projecten in een oogopslag
- Omgevingsvariabelen -- Configuratie van
.envbestanden
- API -- Lokale API-instellingen, databaseinitialisatie en modulearchitectuur
- Webtoepassingen -- B1Admin, B1App en LessonsApp lokaal uitvoeren
- Mobiele apps -- Expo-apps als B1Mobile bouwen
- Gedeelde bibliotheken -- Werken met Helpers, ApiHelper en AppHelper
- Implementatie -- API's, webtoepassingen en mobiele apps implementeren
Gemeenschap en hulpbronnen
| Hulpbron | Link |
|---|---|
| GitHub-organisatie | github.com/ChurchApps |
| Tracker voor problemen | ChurchAppsSupport Issues |
| Slack-gemeenschap | Join Slack |
De snelste manier om bij te dragen is door een webtoepassing (zoals B1Admin) te kiezen, deze naar de staging API's te wijzen en frontend-wijzigingen aan te brengen. Geen database- of API-instellingen vereist.