Preskoči na glavno vsebino

Arhitektura

Te strani so sistemske karte čez več repozitorijev: opisujejo, kako deluje ključni sistem ChurchApps od začetka do konca – čez aplikacije, module API-ja in skupne knjižnice – ne pa, kako je nastavljen posamezen projekt. Preberite jih, preden spremenite vedenje sistema; če želite zagnati projekt, preberite Nastavitev, za podrobnosti o končnih točkah pa razdelek o API-ju.

Ekosistem na prvi pogled​

ChurchApps je ~20 neodvisnih repozitorijev (ne monorepo). Odjemalske aplikacije komunicirajo z manjšim naborom zalednih API-jev prek HTTPS in WebSocket, kodo pa si delijo prek paketov npm, objavljenih pod obsegom @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)

Dve strukturni pravili oblikujeta vse, kar je dokumentirano v tem razdelku:

  1. Moduli so med seboj izolirani. Vsak modul API-ja je lastnik svoje baze podatkov in svojih tabel; drugi moduli in aplikacije do njegovih podatkov dostopajo le prek njegovih REST končnih točk. Glejte Zgradba modula.
  2. Skupna koda je dostavljena kot paketi npm. Aplikacije nikoli ne uvažajo izvorne kode druga druge; vse, kar se ponovno uporablja, prečka meje repozitorijev prek @churchapps/helpers, @churchapps/apphelper ali @churchapps/apihelper. Glejte Skupne knjižnice.

Sistemske karte​

StranKaj zajemaObsega
Obvestila in opomnikiKako nekaj sporoči osebi: dva načina pošiljanja, veriga stopnjevanja kanalov in mehanizem opomnikovApi (messaging), B1Admin, B1App
Arhitektura v realnem časuOgrodje za dostavo prek WebSocket, na katerem temeljijo klepet, prisotnost in dostava znotraj aplikacijeApi (messaging), vse spletne aplikacije
Potisna obvestila v brskalnikuKanal potisnih obvestil v brskalniku: ključi VAPID, shranjevanje naročnin, dostavaApi (messaging), vse spletne aplikacije
DarovanjaPonudniki plačil in plačilni prehodi, tokovi donacij, skladi in serije, webhooki plačilnih prehodovApi (giving), apphelper, B1App, B1Admin
Prijave na dogodkeModel poslovanja pri prijavah: vrste udeležencev, izbire, kode za popust, plačila prek plačilnega prehoda za darovanja ter čakalni seznamApi (content + giving), B1App, B1Admin
Prijave (check-in)Kioskna in samopostrežna prijava, podatkovni model obiskov, usmerjanje po sobah, plast za varnost otrok, tiskanje nalepkB1Checkin, B1App, B1Admin, Api (attendance + membership)
Gradnik spletnih straniDrevo strani, razdelkov in elementov, pogodba za tipe elementov in upodabljalniki, blog, strani z omejenim dostopom, SEO ter generiranje z umetno inteligencoApi (content), AskApi, helpers/apphelper, B1Admin, B1App
Usmerjanje spletnih mest in več mestKako zahtevek preide do cerkve in določenega mesta, podatkovni model več mest s siteId ter robni sloj za domene po meri v CaddyjuB1App, Api (membership + content), B1Admin
IntegracijePovršina za razširitve: OAuth, ključi API, webhooki, ponudniki vsebin, MCPApi, skupne knjižnice, zunanje aplikacije
Dnevnik revizij in serije, ki jih je mogoče razveljavitiPrivzeto vklopljeno revidiranje vsake spremembe na kontrolni točki krmilnika ter plast serij, ki omogoča razveljavitev uvozov in množičnih dejanjApi (all modules), B1Admin, B1Transfer
MinistryStuffPlačana storitev shranjevanja in kreditov za pošiljanje sporočil: identiteta s skupnim JWT-jem, S2S s storitvenimi ključi, ponudniška mesta za sporočila in shranjevanje, obračunavanje prek StripeMinistryStuffApi, MinistryStuffWeb, Api (content + messaging), paketi texting/apihelper, B1Admin
Lastna shramba (BYOS)Cerkve povežejo Google Drive, Dropbox, OneDrive ali vedro, združljivo s S3, za nalaganja, ki presegajo brezplačnih 100 MB: povezava OAuth, oblika nalaganja po ponudnikih, javna preusmeritev prenosaApi (content + membership), paketi helpers/apphelper, B1Admin, B1App
Skupna vsebinaSkupna osnova za sredstva in predloge, ki podpira uporabniško ustvarjeno vsebino čez izdelke, ter enotna čakalna vrsta za moderiranje, dostopna samo osebju v Server Admin v B1AdminApi (commons module), B1Admin, WorshipCommons, Lessons.church, FreeShow
namig

Ko sprememba spremeni delovanje enega od teh sistemov – ne le strani znotraj ene aplikacije –, je treba ustrezno sistemsko karto tukaj posodobiti v istem delu. Tako ostane ta razdelek zanesljiv prvi vir za nove sodelavce.

Predlogi​

Ti dokumenti opisujejo predlagano delo za pregled, ne pa obstoječega delovanja izdelka.

PredlogKaj zajema
Twilio BYOKRačun v lasti cerkve, ključi, storitev in telefonska številka; obseg integracije, soglasje, dostava, ocene in preverjanja pred izdajo
Osnutek uvajanja cerkva v TwilioPredlagane nastavitve prijavnega obrazca B1, primeri kampanj, specifičnih za cerkve, ter kontrolni seznami za odobritev in delovanje