Prejsť na hlavný obsah

Architektúra

Tieto stránky sú systémové mapy naprieč repozitármi: dokumentujú, ako základný systém ChurchApps funguje od začiatku do konca, naprieč aplikáciami, modulmi API a zdieľanými knižnicami, a nie to, ako je nastavený jeden konkrétny projekt. Prečítajte si ich predtým, ako zmeníte správanie systému. Ak chcete spustiť projekt, prečítajte si Nastavenie, a pre referenciu na úrovni endpointov sekciu API.

Ekosystém na prvý pohľad​

ChurchApps tvorí približne 20 nezávislých repozitárov (nie monorepo). Klientske aplikácie komunikujú s malou sadou backendových API cez HTTPS a WebSocket a zdieľajú kód prostredníctvom npm balíkov publikovaných v rozsahu @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 štruktúrne pravidlá formujú všetko, čo je v tejto sekcii zdokumentované:

  1. Moduly sú izolované. Každý modul Api vlastní svoju databázu a svoje tabuľky. Ostatné moduly a aplikácie sa k jeho dátam dostanú iba cez jeho REST endpointy. Pozri Štruktúra modulu.
  2. Zdieľaný kód sa dodáva ako npm balíky. Aplikácie nikdy neimportujú zdrojový kód jedna druhej. Čokoľvek opätovne použité prechádza hranicami repozitárov cez @churchapps/helpers, @churchapps/apphelper alebo @churchapps/apihelper. Pozri Zdieľané knižnice.

Systémové mapy​

StránkaČo pokrývaZasahuje
Oznámenia a pripomienkyAko niečo informuje človeka: dva odosielacie vstupy, reťaz eskalácie kanálov a motor pripomienokApi (messaging), B1Admin, B1App
Architektúra reálneho časuFramework doručovania cez WebSocket za chatom, prítomnosťou a doručovaním v aplikáciiApi (messaging), všetky webové aplikácie
Webové push notifikácieKanál webových push notifikácií v prehliadači: kľúče VAPID, ukladanie predplatných, doručovanieApi (messaging), všetky webové aplikácie
DaryPoskytovatelia platieb a brány, toky darov, fondy a dávky, webhooky bránApi (giving), apphelper, B1App, B1Admin
Registrácie na udalostiModel obchodovania s registráciami: typy účastníkov, výbery, zľavové kódy, platby cez bránu darov a čakacia listinaApi (content + giving), B1App, B1Admin
Check-inyKiosk a samoobslužný check-in, dátový model účasti, smerovanie do miestností, vrstva ochrany detí, tlač štítkovB1Checkin, B1App, B1Admin, Api (attendance + membership)
Tvorca webovStrom stránok, sekcií a prvkov, zmluva o type prvku a renderery, blog, stránky s prístupom, SEO a generovanie pomocou AIApi (content), AskApi, helpers/apphelper, B1Admin, B1App
Smerovanie webov a viacero stránokAko sa požiadavka priradí k cirkvi a konkrétnej stránke, dátový model viacerých stránok so siteId a okrajová vrstva Caddy pre vlastné doményB1App, Api (membership + content), B1Admin
IntegrácieRozširujúca plocha: OAuth, API kľúče, webhooky, poskytovatelia obsahu, MCPApi, zdieľané knižnice, externé aplikácie
Auditný záznam a vratné dávkyPredvolené auditovanie každej mutácie na kontrolnom bode kontrolérov a vrstva dávok, vďaka ktorej sú importy a hromadné akcie vratnéApi (všetky moduly), B1Admin, B1Transfer
MinistryStuffPlatená služba úložiska a kreditov na SMS: identita cez zdieľaný JWT, S2S cez service-key, rozhrania poskytovateľov SMS a úložiska, fakturácia cez StripeMinistryStuffApi, MinistryStuffWeb, Api (content + messaging), balíky texting/apihelper, B1Admin
Vlastné úložisko (BYOS)Cirkvi prepájajú Google Drive, Dropbox, OneDrive alebo S3-kompatibilný bucket pre nahrávanie nad bezplatných 100 MB: pripojenie OAuth, tvary nahrávania pre jednotlivých poskytovateľov, verejné presmerovanie na stiahnutieApi (content + membership), balíky helpers/apphelper, B1Admin, B1App
Zdieľaný obsah (Content Commons)Zdieľaná chrbtica assetov a príspevkov pre používateľský obsah naprieč produktmi a jediný moderačný front len pre zamestnancov v B1Admin Server AdminApi (modul commons), B1Admin, WorshipCommons, Lessons.church, FreeShow
tip

Keď zmena mení, ako funguje jeden z týchto systémov, a nie len stránka v jednej aplikácii, príslušná systémová mapa sa má aktualizovať v rovnakom kroku. Tak zostane táto sekcia dôveryhodným prvým zdrojom pre nových prispievateľov.

Návrhy​

Tieto dokumenty opisujú navrhovanú prácu na posúdenie, a nie dostupné správanie produktu.

NávrhČo pokrýva
Twilio BYOKÚčet, kľúče, služba a telefónne číslo vo vlastníctve cirkvi; rozsah integrácie, súhlas, doručovanie, odhady a kontroly pred vydaním
Návrh zavedenia cirkví pre TwilioNavrhované nastavenia registračného formulára B1, príklady kampaní pre konkrétne cirkvi a kontrolné zoznamy schválenia a prevádzky