Ugrás a fő tartalomra

Architektúra

Ezek az oldalak több repót átfogó rendszertérképek: a rendszer működését végponttól végpontig dokumentálják, az alkalmazásokon, az API-modulokon és a megosztott könyvtárakon átívelően, nem pedig egyetlen projekt beállítását. Olvasd el őket, mielőtt módosítanál egy rendszer működésén. A projekt elindításához a Beállítás oldalt, a végpontszintű referenciához pedig az API-szakaszt olvasd el.

Az ökoszisztéma áttekintése​

A ChurchApps mintegy 20 független repóból áll (nem monorepo). A kliensalkalmazások HTTPS-en és WebSocketen keresztül kommunikálnak néhány backend API-val, a kódot pedig a @churchapps hatókörben közzétett npm-csomagokon keresztül osztják meg.

┌────────────────────────────────┐            ┌──────────────────────────────────────────────┐
│ 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)

Két szerkezeti szabály határozza meg ebben a szakaszban dokumentált minden elemet:

  1. A modulok el vannak szigetelve. Minden Api-modul a saját adatbázisát és tábláit birtokolja; más modulok és alkalmazások csak a REST-végpontjain keresztül férnek hozzá az adataihoz. Lásd: Modulstruktúra.
  2. A megosztott kód npm-csomagként érkezik. Az alkalmazások nem importálják egymás forráskódját; ami újrahasznosításra kerül, az repóhatárokon át a @churchapps/helpers, @churchapps/apphelper vagy @churchapps/apihelper csomagon keresztül jut el. Lásd: Megosztott könyvtárak.

Rendszertérképek​

OldalMit fed leÉrintett területek
Értesítések és emlékeztetőkHogyan értesít valaki valakit valamiről: a két küldési csatorna, a csatornák fokozatos láncolata és az emlékeztető-motorApi (messaging), B1Admin, B1App
Valós idejű architektúraA WebSocket-kézbesítési keretrendszer, amely a csevegést, a jelenlétet és az alkalmazáson belüli kézbesítést támogatjaApi (messaging), minden webes alkalmazás
Webes push-értesítésekA böngészős push-csatorna: VAPID-kulcsok, feliratkozások tárolása, kézbesítésApi (messaging), minden webes alkalmazás
AdományozásFizetési szolgáltatók és átjárók, adományozási folyamatok, alapok és kötegek, átjáró-webhookokApi (giving), apphelper, B1App, B1Admin
EseménybejelentkezésekA regisztrációs kereskedelmi modell: résztvevőtípusok, kiválasztások, kedvezménykódok, fizetések az adományozási átjárón keresztül és a várólistaApi (content + giving), B1App, B1Admin
BejelentkezésekKiosk- és önálló bejelentkezés, a részvételi adatmodell, a termek útválasztása, a gyermekvédelmi réteg és a címkenyomtatásB1Checkin, B1App, B1Admin, Api (attendance + membership)
Webhely-készítőAz oldal/szakasz/elem fa, az elemtípus-szerződés és a renderelők, a blog, a hozzáférés-korlátozott oldalak, az SEO és az AI-generálásApi (content), AskApi, helpers/apphelper, B1Admin, B1App
Webhely-útválasztás és több webhelyHogyan oldódik fel egy kérés egy gyülekezetre és egy adott webhelyre, a többwebhelyes siteId adatmodell és a Caddy egyedi domain-széleB1App, Api (membership + content), B1Admin
IntegrációkA bővítési felület: OAuth, API-kulcsok, webhookok, tartalomszolgáltatók, MCPApi, megosztott könyvtárak, külső alkalmazások
Naplózás és visszavonható kötegekAlapértelmezetten bekapcsolt naplózás minden módosításra a vezérlő ellenőrzési pontján, valamint a kötegrétegek, amelyek az importálásokat és a tömeges műveleteket visszavonhatóvá teszikApi (all modules), B1Admin, B1Transfer
MinistryStuffA fizetős tárhely- és SMS-kreditszolgáltatás: megosztott JWT-identitás, szolgáltatókulcsos S2S, az SMS- és tárhelyszolgáltatók illesztőpontjai, Stripe-számlázásMinistryStuffApi, MinistryStuffWeb, Api (content + messaging), texting/apihelper csomagok, B1Admin
Saját tárhely (BYOS)A gyülekezetek a 100 MB-os ingyenes keret fölötti feltöltésekhez Google Drive-ot, Dropboxot, OneDrive-ot vagy S3-kompatibilis tárolót kapcsolhatnak: OAuth-kapcsolat, szolgáltatónkénti feltöltési formák, nyilvános letöltési átirányításApi (content + membership), helpers/apphelper csomagok, B1Admin, B1App
TartalomközösségA termékek közötti, felhasználók által létrehozott tartalmak közös eszköz- és beküldési gerince, valamint az egyetlen, csak munkatársaknak szóló moderációs sor a B1Admin Server AdminbanApi (commons module), B1Admin, WorshipCommons, Lessons.church, FreeShow
tipp

Ha egy változtatás e rendszerek valamelyikének működését érinti, nem csupán egy alkalmazáson belüli oldalt, akkor a megfelelő rendszertérképet ugyanabban a munkában kell frissíteni. Így ez a szakasz megbízható marad az új közreműködők első megállójaként.

Javaslatok​

Ezek a dokumentumok felülvizsgálatra szánt javasolt munkát írnak le, nem pedig elérhető termékfunkciókat.

JavaslatMit fed le
Twilio BYOKGyülekezet tulajdonában lévő fiók, kulcsok, szolgáltatás és telefonszám; integrációs hatókör, hozzájárulás, kézbesítés, becslések és kiadási ellenőrzések
Twilio gyülekezeti regisztráció – tervezetJavasolt B1 regisztrációs űrlap-beállítások, gyülekezet-specifikus kampánypéldák és jóváhagyási, illetve üzemeltetési ellenőrzőlisták