Utviklerdokumentasjon
ChurchApps er en samling på omtrent 20 prosjekter med åpen kildekode som til sammen utgjør en komplett plattform for menighetsadministrasjon. Prosjektene omfatter backend-API-er, webapplikasjoner, mobilapper, et skrivebordsprogram og delte biblioteker, alt skrevet i TypeScript. Denne delen inneholder alt du trenger for å sette opp et lokalt utviklingsmiljø og begynne å bidra.
Arkitektur i korte trekk
Prosjektene er uavhengige repositorier (ikke et monorepo). Delt kode publiseres til npm under @churchapps/*-scopet og brukes som vanlige avhengigheter. Det betyr at du kan jobbe med ett enkelt prosjekt uten å klone hele økosystemet.
Viktige kjennetegn:
- Språk: TypeScript gjennomgående
- Backend: Node.js / Express-API-er distribuert til AWS Lambda via Serverless Framework
- Web: React 19 (Vite og Next.js), Material-UI 7
- Mobil: React Native med Expo
- Database: MySQL 8.0, én database per API-modul
Hva denne delen dekker
- Oppsett -- Lokalt utviklingsmiljø, forutsetninger og konfigurasjon
- Forutsetninger -- Nødvendige verktøy og programvare
- Prosjektoversikt -- Alle prosjekter i oversikt
- Miljøvariabler -- Konfigurering av
.env-filer
- API -- Lokalt oppsett av kjerne-API, databaseinitialisering og modulstruktur
- Webapper -- Kjøre B1Admin, B1App og LessonsApp lokalt
- Mobilapper -- Bygge B1Checkin og andre Expo-apper
- Delte biblioteker -- Arbeide med Helpers, ApiHelper og AppHelper
- Distribusjon -- Distribuere API-er, webapper og mobilapper
- FreePlay-innholdsleverandør -- Integrere leksjonsbiblioteket ditt med FreePlay
Fellesskap og ressurser
| Ressurs | Lenke |
|---|---|
| GitHub-organisasjon | github.com/ChurchApps |
| Saksliste | ChurchAppsSupport Issues |
| Slack-fellesskap | Bli med i Slack |
Den raskeste måten å begynne å bidra på er å velge en webapp (som B1Admin), koble den til de delte demo-API-ene, og begynne å gjøre endringer i frontend. Ingen database- eller API-oppsett kreves.