Utviklerdokumentasjon
ChurchApps er en samling av omtrent 20 åpen kildekode-prosjekter som sammen utgjør en komplett plattform for kirkeadministrasjon. Prosjektene spenner over backend-API-er, webapplikasjoner, mobilapper, en skrivebordsapplikasjon og delte biblioteker -- alle skrevet i TypeScript. Denne seksjonen gir deg alt du trenger for å sette opp et lokalt utviklingsmiljø og begynne å bidra.
Arkitektur i et nøtteskall
Prosjektene er uavhengige repositorier (ikke et monorepo). Delt kode publiseres til npm under @churchapps/*-scope og konsumeres som vanlige avhengigheter. Dette betyr at du kan jobbe på et enkelt prosjekt uten å klone hele økosystemet.
Hovedegenskaper:
- 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 seksjonen dekker
- Oppsett -- Lokalt utviklingsmiljø, forutsetninger og konfigurasjon
- Forutsetninger -- Nødvendige verktøy og programvare
- Prosjektoversikt -- Alle prosjekter i en oversikt
- Miljøvariabler -- Konfigurering av
.env-filer
- API -- Lokalt oppsett av kjerne-API, databaseinitialisering og modulstruktur
- Webapper -- Kjøring av B1Admin, B1App og LessonsApp lokalt
- Mobilapper -- Bygging av B1Mobile og andre Expo-apper
- Delte biblioteker -- Arbeid med Helpers, ApiHelper og AppHelper
- Distribusjon -- Distribusjon av API-er, webapper og mobilapper
Fellesskap og ressurser
| Ressurs | Lenke |
|---|---|
| GitHub-organisasjon | github.com/ChurchApps |
| Feilsporing | ChurchAppsSupport Issues |
| Slack-fellesskap | Bli med på Slack |
Den raskeste måten å begynne å bidra på er å velge en webapp (som B1Admin), peke den mot staging-API-ene, og begynne å gjøre frontend-endringer. Ingen database- eller API-oppsett kreves.