Архитектура
Ове странице су системске мапе преко више репозиторијума: документују како функционише основни ChurchApps систем од почетка до краја, кроз апликације, API модуле и дељене библиотеке, а не како је подешен један појединачни пројекат. Прочитајте их пре него што промените понашање система. Прочитајте Подешавање да бисте покренули пројекат и одељак о API-ју за референцу на нивоу крајњих тачака.
Екосистем укратко
ChurchApps чини око 20 независних репозиторијума (није монорепо). Клијентске апликације комуницирају са малим скупом позадинских API-ја преко HTTPS-а и WebSocket-а, а код деле кроз npm пакете објављене под @churchapps опсегом.
┌────────────────────────────────┐ ┌──────────────────────────────────────────────┐
│ Клијенти │ │ Api — језгро модуларног монолита (AWS Lambda)│
│ │ │ │
│ B1Admin табла особља │ HTTPS │ чланство присуство садржај │
│ B1App портал чланова + │ ─────────▶ │ прилози поруке служења │
│ веб-сајтови цркава │ │ │
│ B1Checkin пријава на киоску │ ◀───WS───▶ │ једна MySQL база по модулу (укупно 6) │
│ │ └──────────────────────────────────────────────┘
│ FreePlay ТВ плејер садржаја │ ┌──────────────────────────────────────────────┐
└───────────────┬────────────────┘ │ LessonsApi — позадина Lessons.church │
│ └──────────────────────────────────────────────┘
│ дељени код преко npm (@churchapps/*)
▼
helpers (интерфејси између апликација) · apphelper (React компоненте) · apihelper (Express/серверске помоћне функције)
Два структурална правила опредељују све што је документовано у овом одељку:
- Модули су изоловани. Сваки Api модул поседује своју базу података и своје табеле. Други модули и апликације приступају његовим подацима само преко његових REST крајњих тачака. Погледајте Структура модула.
- Дељени код се испоручује као npm пакети. Апликације никада не увозе изворни код једна друге. Све што се поново користи прелази границе репозиторијума преко
@churchapps/helpers,@churchapps/apphelperили@churchapps/apihelper. Погледајте Дељене библиотеке.
Системске мапе
| Страница | Шта обухвата | Обухвата |
|---|---|---|
| Обавештења и подсетници | Како било шта обавештава особу: два улаза за слање, ланац ескалације канала и механизам за подсетнике | Api (messaging), B1Admin, B1App |
| Архитектура у реалном времену | Оквир за испоруку преко WebSocket-а иза ћаскања, присуства и испоруке унутар апликације | Api (messaging), све веб апликације |
| Веб push обавештења | Канал push обавештења у прегледачу: VAPID кључеви, складиштење претплата, испорука | Api (messaging), све веб апликације |
| Прилози | Провајдери плаћања и пролази, токови донација, фондови и серије, webhook-ови пролаза | Api (giving), apphelper, B1App, B1Admin |
| Пријаве на догађаје | Модел трговине за пријаве: типови учесника, избори, кодови попуста, плаћања преко пролаза за прилоге и листа чекања | Api (content + giving), B1App, B1Admin |
| Пријављивање долазака | Пријављивање на киоску и самостално пријављивање, модел података о присуству, рутирање по просторијама, слој заштите деце, штампање налепница | B1Checkin, B1App, B1Admin, Api (attendance + membership) |
| Градитељ веб сајтова | Стабло страница, секција и елемената, уговор о типовима елемената и рендерерима, блог, странице са ограниченим приступом, SEO и генерисање помоћу вештачке интелигенције | Api (content), AskApi, helpers/apphelper, B1Admin, B1App |
| Рутирање веб сајтова и више сајтова | Како се захтев разрешава до цркве и одређеног сајта, модел података за више сајтова са siteId и Caddy ивица за прилагођене домене | B1App, Api (membership + content), B1Admin |
| Интеграције | Површина за проширења: OAuth, API кључеви, webhook-ови, провајдери садржаја, MCP | Api, дељене библиотеке, спољне апликације |
| Дневник ревизије и серије које се могу поништити | Аутоматска ревизија сваке измене на контролерској тачки пролаза и слој серија који омогућава поништавање увоза и масовних радњи | Api (сви модули), B1Admin, B1Transfer |
| MinistryStuff | Плаћена услуга складиштења и кредита за SMS: заједнички JWT идентитет, S2S аутентификација кључем сервиса, спојнице провајдера за SMS и складиштење, Stripe наплата | MinistryStuffApi, MinistryStuffWeb, Api (content + messaging), пакети texting/apihelper, B1Admin |
| Сопствено складиште | Цркве повезују Google Drive, Dropbox, OneDrive или S3-компатибилан бакет за отпремања преко бесплатних 100 MB: OAuth повезивање, облици отпремања за сваког провајдера, јавно преусмеравање за преузимање | Api (content + membership), пакети helpers/apphelper, B1Admin, B1App |
| Заједнички садржај | Заједничка окосница средстава и пријава иза корисничког садржаја који се користи у више производа и јединствена модерацијска листа само за особље у Server Admin-у B1Admin-а | Api (commons module), B1Admin, WorshipCommons, Lessons.church, FreeShow |
Када промена мења начин рада једног од ових система, а не само страницу унутар једне апликације, одговарајућу системску мапу овде треба ажурирати у оквиру истог посла. Тако овај одељак остаје поуздан први извор за нове сараднике.
Предлози
Ови документи описују предложени рад на прегледу, а не постојеће понашање производа.
| Предлог | Шта обухвата |
|---|---|
| Twilio BYOK | Налог, кључеви, сервис и телефонски број у власништву цркве; обим интеграције, сагласност, испорука, процене и провере при објављивању |
| Нацрт уводног процеса за цркве у Twilio-у | Предложена подешавања образаца за пријаву у B1, примери кампања специфичних за цркве и контролне листе за одобравање и рад |