Hoppa till huvudinnehål

Arkitektur

Dessa sidor är systemkartor över flera repositorier: de dokumenterar hur ett centralt ChurchApps-system fungerar från början till slut, över apparna, API-modulerna och de delade biblioteken, snarare än hur ett enskilt projekt är konfigurerat. Läs dem innan du ändrar ett systems beteende. Läs Installation för att få ett projekt igång och API-avsnittet för referens på endpoint-nivå.

Ekosystemet i korthet​

ChurchApps består av ~20 oberoende repositorier (inte en monorepo). Klientappar kommunicerar med ett litet antal backend-API:er över HTTPS och WebSocket, och delar kod via npm-paket publicerade under scopet @churchapps.

┌────────────────────────────────┐            ┌──────────────────────────────────────────────┐
│ Clients │ │ Api — core modular monolith (AWS Lambda) │
│ │ │ │
│ B1Admin staff dashboard │ HTTPS │ membership attendance content │
│ B1App member portal + │ ─────────▶ │ giving messaging doing │
│ church websites │ │ │
│ B1Checkin check-in kiosk │ ◀───WS───▶ │ one MySQL database per module (6 total) │
│ │ └──────────────────────────────────────────────┘
│ FreePlay TV content player │ ┌──────────────────────────────────────────────┐
└───────────────┬────────────────┘ │ LessonsApi — Lessons.church backend │
│ └──────────────────────────────────────────────┘
│ shared code via npm (@churchapps/*)
▼
helpers (cross-app interfaces) · apphelper (React components) · apihelper (Express/server utilities)

Två strukturella regler styr allt som dokumenteras i det här avsnittet:

  1. Modulerna är isolerade. Varje Api-modul äger sin databas och sina tabeller. Andra moduler och appar når dess data endast via dess REST-endpoints. Se Modulstruktur.
  2. Delad kod levereras som npm-paket. Appar importerar aldrig varandras källkod. Allt som återanvänds korsar repogränser via @churchapps/helpers, @churchapps/apphelper eller @churchapps/apihelper. Se Delade bibliotek.

Systemkartor​

SidaVad den täckerOmfattar
Aviseringar & påminnelserHur något förmedlar information till en person: de två utskicksingångarna, eskaleringskedjan för kanaler och påminnelsemotornApi (messaging), B1Admin, B1App
RealtidsarkitekturWebSocket-leveransramverket bakom chatt, närvaro och leverans i appenApi (messaging), alla webbappar
Webbpush-notifikationerWebbläsarens pushkanal: VAPID-nycklar, lagring av prenumerationer, leveransApi (messaging), alla webbappar
GåvorBetalningsleverantörer och gateways, gåvoflöden, fonder/batcher, gateway-webhooksApi (giving), apphelper, B1App, B1Admin
EventregistreringarRegistreringsmodellen för kommers: deltagartyper, val, rabattkoder, betalningar via gåvogatewayen och väntelistanApi (content + giving), B1App, B1Admin
IncheckningarKiosk- och självincheckning, närvarodatamodellen, rumsrouting, barnsäkerhetslagret, etikettutskriftB1Checkin, B1App, B1Admin, Api (attendance + membership)
WebbplatsbyggarenSid-/sektions-/elementträdet, kontraktet för elementtyper och renderare, blogg, åtkomstskyddade sidor, SEO och AI-genereringApi (content), AskApi, helpers/apphelper, B1Admin, B1App
Webbplatsrouting & flera webbplatserHur en förfrågan kopplas till en kyrka och en specifik webbplats, datamodellen för flera webbplatser med siteId och Caddy-kantnoden för egna domänerB1App, Api (membership + content), B1Admin
IntegrationerUtökningsytan: OAuth, API-nycklar, webhooks, innehållsleverantörer, MCPApi, delade bibliotek, externa appar
Granskningslogg & ångringsbara batcherStandardaktiverad granskning av varje ändring vid controllerns kontrollpunkt, och batchlagret som gör importer och massåtgärder ångringsbaraApi (alla moduler), B1Admin, B1Transfer
MinistryStuffDen betalda tjänsten för lagring och SMS-krediter: delad JWT-identitet, S2S med tjänstnyckel, leverantörsgränssnitten för SMS och lagring, Stripe-faktureringMinistryStuffApi, MinistryStuffWeb, Api (content + messaging), texting/apihelper-paket, B1Admin
Egen lagring (BYOS)Kyrkor kopplar Google Drive, Dropbox, OneDrive eller en S3-kompatibel bucket för uppladdningar över de kostnadsfria 100 MB: OAuth-anslutning, uppladdningsformat per leverantör, den offentliga nedladdningsomdirigeringenApi (content + membership), helpers/apphelper-paket, B1Admin, B1App
Content CommonsDen delade tillgångs- och inlämningsstrukturen bakom användargenererat innehåll över produkter, och den enda modereringskön för endast personal i B1Admin Server AdminApi (commons-modulen), B1Admin, WorshipCommons, Lessons.church, FreeShow
tips

När en ändring påverkar hur ett av dessa system fungerar, inte bara en sida i en enskild app, bör motsvarande systemkarta här uppdateras i samma arbete. Det håller det här avsnittet tillförlitligt som första stopp för nya bidragsgivare.

Förslag​

Dessa dokument beskriver föreslaget arbete för granskning, snarare än tillgängligt produktbeteende.

FörslagVad den täcker
Twilio BYOKKyrkans egna konto, nycklar, tjänst och telefonnummer; integrationens omfattning, samtycke, leverans, uppskattningar och släppkontroller
Twilio-utkast för kyrkans onboardingFöreslagna inställningar för B1:s registreringsformulär, kyrkspecifika kampanjexempel och checklistor för godkännande och drift