Přejít na hlavní obsah

Architektura

Tyto stránky jsou mapy systémů napříč repozitáři: popisují, jak základní systém ChurchApps funguje od začátku do konce, napříč aplikacemi, moduly API a sdílenými knihovnami, a ne jak je nastaven jednotlivý projekt. Před změnou chování systému si je přečtěte. Nastavení vám pomůže spustit projekt a sekce API slouží jako referenční přehled endpointů.

Ekosystém na první pohled​

ChurchApps je přibližně 20 nezávislých repozitářů (nikoli monorepo). Klientské aplikace komunikují s malou sadou backendových API přes HTTPS a WebSocket a sdílejí kód prostřednictvím npm balíčků publikovaných pod scope @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)

Dvě strukturální pravidla formují vše, co je v této sekci popsáno:

  1. Moduly jsou izolované. Každý modul API vlastní svou databázi a své tabulky; ostatní moduly a aplikace se k jeho datům dostanou pouze přes jeho REST endpointy. Viz Struktura modulu.
  2. Sdílený kód se distribuuje jako npm balíčky. Aplikace nikdy neimportují zdrojový kód jedna druhé; cokoli znovupoužitelného přechází hranice repozitářů přes @churchapps/helpers, @churchapps/apphelper nebo @churchapps/apihelper. Viz Sdílené knihovny.

Mapy systémů​

StránkaCo pokrýváZasahuje
Oznámení a připomínkyJak cokoli sdělí osobě zprávu: dvě odesílací brány, řetězec eskalace kanálů a engine připomínekApi (messaging), B1Admin, B1App
Architektura v reálném časeFramework pro doručování přes WebSocket, na kterém stojí chat, přítomnost a doručování v aplikaciApi (messaging), všechny webové aplikace
Webové push notifikaceKanál push notifikací v prohlížeči: klíče VAPID, ukládání odběrů, doručováníApi (messaging), všechny webové aplikace
DaryPlatební poskytovatelé a brány, toky darů, fondy a dávky, webhooky branApi (giving), apphelper, B1App, B1Admin
Registrace na akceModel registrací na akce: typy účastníků, výběry, slevové kódy, platby přes bránu darů a čekací listinaApi (content + giving), B1App, B1Admin
Check-inyCheck-in na kiosku i samoobslužný check-in, datový model docházky, směrování do místností, vrstva ochrany dětí, tisk štítkůB1Checkin, B1App, B1Admin, Api (attendance + membership)
Tvorba webuStrom stránek, sekcí a prvků, kontrakt typů prvků a renderery, blog, stránky s přístupem omezeným na skupiny, SEO a generování pomocí AIApi (content), AskApi, helpers/apphelper, B1Admin, B1App
Směrování webů a více webůJak se požadavek přiřadí ke konkrétnímu kostelu a konkrétnímu webu, datový model více webů se siteId a okrajová vrstva Caddy pro vlastní doményB1App, Api (membership + content), B1Admin
IntegraceRozšiřitelná plocha: OAuth, klíče API, webhooky, poskytovatelé obsahu, MCPApi, sdílené knihovny, externí aplikace
Auditní log a dávky s možností vráceníVýchozí auditování každé změny v bodu řízení kontroleru a vrstva dávek, která umožňuje vrátit importy a hromadné akce zpětApi (všechny moduly), B1Admin, B1Transfer
MinistryStuffPlacená služba pro úložiště a kredity na SMS: identita přes sdílený JWT, S2S s servisním klíčem, rozhraní poskytovatelů SMS a úložiště, fakturace přes StripeMinistryStuffApi, MinistryStuffWeb, Api (content + messaging), balíčky texting/apihelper, B1Admin
Vlastní úložištěKostely mohou pro nahrávání nad bezplatných 100 MB propojit Disk Google, Dropbox, OneDrive nebo bucket kompatibilní s S3: připojení přes OAuth, tvar nahrávání pro jednotlivé poskytovatele, veřejné přesměrování pro stahováníApi (content + membership), balíčky helpers/apphelper, B1Admin, B1App
Content CommonsSdílená páteř aktiv a příspěvků pro uživatelský obsah napříč produkty a jediná fronta moderace pro zaměstnance v Server Admin v B1AdminApi (modul commons), B1Admin, WorshipCommons, Lessons.church, FreeShow
tip

Když změna ovlivní, jak některý z těchto systémů funguje, a ne jen stránku uvnitř jedné aplikace, je třeba ve stejné práci aktualizovat odpovídající mapu systému zde. Tím zůstane tato sekce důvěryhodným prvním místem pro nové přispěvatele.

Návrhy​

Tyto dokumenty popisují navrhované práce k posouzení, nikoli dostupné chování produktu.

NávrhCo pokrývá
Twilio BYOKVlastní účet, klíče, služba a telefonní číslo kostela; rozsah integrace, souhlas, doručování, odhady a kontroly před vydáním
Návrh zavedení Twilio pro kostelyNavrhovaná nastavení registračního formuláře v B1, příklady kampaní pro konkrétní kostely a kontrolní seznamy pro schválení a provoz