Pereiti prie pagrindiniam turinį

Architektūra

Šie puslapiai yra tarpsisteminės sistemos schemos: jie aprašo, kaip pagrindinė ChurchApps sistema veikia nuo pradžios iki galo, įskaitant programėles, API modulius ir bendrąsias bibliotekas, o ne tai, kaip nustatomas atskiras projektas. Prieš keisdami sistemos elgseną, perskaitykite juos. Norėdami paleisti projektą, skaitykite Sąranka, o galutinių taškų (endpoint) lygio nuorodai žiūrėkite API skyrių.

Ekosistema vienu žvilgsniu​

ChurchApps sudaro apie 20 nepriklausomų saugyklų (tai ne monorepo). Klientinės programėlės bendrauja su nedideliu skaičiumi backend API per HTTPS ir WebSocket ir dalijasi kodu per npm paketus, publikuojamus @churchapps vardų erdvėje.

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

Du struktūriniai principai, kuriais grindžiamas visas šiame skyriuje aprašytas turinys:

  1. Moduliai yra izoliuoti. Kiekvienas Api modulis valdo savo duomenų bazę ir lenteles. Kiti moduliai ir programėlės prie jo duomenų prieina tik per jo REST galutinius taškus. Žr. Modulio struktūra.
  2. Bendras kodas platinamas kaip npm paketai. Programėlės niekada neimportuoja viena kitos šaltinio kodo. Bet kas, kas perpanaudojama, peržengia saugyklų ribas per @churchapps/helpers, @churchapps/apphelper ar @churchapps/apihelper. Žr. Bendrosios bibliotekos.

Sistemų schemos​

PuslapisKą apimaApima
Pranešimai ir priminimaiKaip kas nors praneša asmeniui kažką: dvi siuntimo „durys“, kanalų eskalavimo grandinė ir priminimų variklisApi (messaging), B1Admin, B1App
Realaus laiko architektūraWebSocket pristatymo sistema, kuri palaiko pokalbius, buvimo rodymą ir pristatymą programėlėjeApi (messaging), visos web programėlės
Web Push pranešimaiNaršyklės push kanalas: VAPID raktai, prenumeratų saugojimas, pristatymasApi (messaging), visos web programėlės
AukojimaiMokėjimo teikėjai ir šliuzai, aukojimų srautai, fondai ir partijos, šliuzų webhook'aiApi (giving), apphelper, B1App, B1Admin
Renginių registracijosRegistracijos komercinis modelis: dalyvių tipai, pasirinkimai, nuolaidų kodai, mokėjimai per aukojimų šliuzą ir laukiamųjų sąrašasApi (content + giving), B1App, B1Admin
Atvykimo registracijaKioskų ir savitarnos atvykimo registracija, lankomumo duomenų modelis, kambarių maršrutizavimas, vaikų saugumo sluoksnis, etikečių spausdinimasB1Checkin, B1App, B1Admin, Api (attendance + membership)
Svetainių kūrėjasPuslapių, skyrių ir elementų medis, elementų tipo sutartis ir atvaizdavimo komponentai, tinklaraštis, prieigos apribotos puslapiai, SEO ir DI generavimasApi (content), AskApi, helpers/apphelper, B1Admin, B1App
Svetainių maršrutizavimas ir kelios svetainėsKaip užklausa nukreipiama į bažnyčią ir konkrečią svetainę, kelių svetainių siteId duomenų modelis ir Caddy pasirinktinių domenų kraštasB1App, Api (membership + content), B1Admin
IntegracijosPlėtinių paviršius: OAuth, API raktai, webhook'ai, turinio teikėjai, MCPApi, bendrosios bibliotekos, išorinės programėlės
Audito žurnalas ir atšaukiami paketaiPagal numatytuosius nustatymus įjungtas kiekvieno pakeitimo auditas kontrolerio kontrolės taške ir paketų sluoksnis, leidžiantis atšaukti importus ir masinius veiksmusApi (visi moduliai), B1Admin, B1Transfer
MinistryStuffMokama saugyklos ir SMS kreditų paslauga: bendru JWT pagrindu grindžiama tapatybė, S2S su paslaugos raktu, SMS ir saugyklos teikėjų sąsajos, Stripe atsiskaitymaiMinistryStuffApi, MinistryStuffWeb, Api (content + messaging), texting/apihelper paketai, B1Admin
Savo saugykla (BYOS)Bažnyčios susieja Google Drive, Dropbox, OneDrive ar S3 suderinamą saugyklą įkėlimams, viršijantiems nemokamus 100 MB: OAuth prijungimas, kiekvieno teikėjo įkėlimo formos, viešas atsisiuntimo peradresavimasApi (content + membership), helpers/apphelper paketai, B1Admin, B1App
Turinio bendrijaBendras turto ir pateikimų pagrindas, kuriuo remiasi produktų ribas peržengiantis vartotojų sukurtas turinys, ir vienintelė tik darbuotojams skirta moderavimo eilė B1Admin Server AdminApi (commons module), B1Admin, WorshipCommons, Lessons.church, FreeShow
patarimas

Kai pakeitimas keičia vienos iš šių sistemų veikimą, o ne tik puslapį viename iš programėlių, atitinkama sistemos schema čia turi būti atnaujinta tuo pačiu darbu. Tai išlaiko šį skyrių patikimu pirmuoju šaltiniu naujiems prisidedantiems asmenims.

Pasiūlymai​

Šiuose dokumentuose aprašomi siūlomi darbai peržiūrai, o ne esamas produkto elgesys.

PasiūlymasKą apima
Twilio BYOKBažnyčiai priklausanti paskyra, raktai, paslauga ir telefono numeris; integracijos apimtis, sutikimas, pristatymas, įvertinimai ir išleidimo patikros
Twilio bažnyčios įtraukimo juodraštisSiūlomi B1 registracijos formos nustatymai, bažnyčiai specifiniai kampanijų pavyzdžiai ir patvirtinimo bei veiklos kontroliniai sąrašai