Архітектура
Ці сторінки є міжрепозиторними системними картами: вони описують, як працює основна системна функція ChurchApps від початку до кінця, через застосунки, модулі API та спільні бібліотеки, а не як налаштовується окремий проєкт. Читайте їх перед зміною поведінки системи, а Налаштування використовуйте, щоб запустити проєкт, і розділ API для довідки щодо ендпоїнтів.
Екосистема з першого погляду
ChurchApps складається приблизно з 20 незалежних репозиторіїв (це не монорепозиторій). Клієнтські застосунки взаємодіють з невеликим набором backend API через HTTPS і WebSocket та спільно використовують код через npm-пакети в області @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)
Дві структурні правила визначають усе, що описано в цьому розділі:
- Модулі ізольовані. Кожен модуль Api володіє своєю базою даних і своїми таблицями; інші модулі та застосунки отримують доступ до його даних лише через його REST-ендпоїнти. Див. Структура модуля.
- Спільний код поставляється як npm-пакети. Застосунки ніколи не імпортують вихідний код один одного; усе, що використовується повторно, перетинає межі репозиторіїв через
@churchapps/helpers,@churchapps/apphelperабо@churchapps/apihelper. Див. Спільні бібліотеки.
Системні карти
| Сторінка | Що охоплює | Залучені компоненти |
|---|---|---|
| Сповіщення та нагадування | Як щось повідомляє людину: два канали доставки, ланцюжок ескалації каналів і механізм нагадувань | Api (messaging), B1Admin, B1App |
| Архітектура реального часу | Фреймворк доставки WebSocket, що лежить в основі чату, присутності та доставки всередині застосунку | Api (messaging), усі веб-застосунки |
| Web 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 |
| Власне сховище (BYOS) | Церкви підключають Google Drive, Dropbox, OneDrive або S3-сумісний бакет для завантажень понад безкоштовні 100 МБ: підключення через OAuth, формати завантаження для кожного провайдера, публічне перенаправлення для завантаження | Api (content + membership), пакети helpers/apphelper, B1Admin, B1App |
| Content Commons | Спільна основа активів і подань, що лежить в основі крос-продуктового контенту, створеного користувачами, та єдина черга модерації лише для персоналу в Server Admin B1Admin | Api (модуль commons), B1Admin, WorshipCommons, Lessons.church, FreeShow |
Коли зміна змінює роботу однієї з цих систем, а не лише сторінку в одному застосунку, відповідну системну карту тут потрібно оновити в межах того самого завдання. Так цей розділ залишатиметься надійною першою точкою入門 для нових учасників.
Пропозиції
Ці документи описують запропоновану роботу для розгляду, а не доступну функціональність продукту.
| Пропозиція | Що охоплює |
|---|---|
| Twilio BYOK | Обліковий запис, ключі, служба та номер телефону, що належать церкві; обсяг інтеграції, згода, доставка, оцінки та перевірки перед випуском |
| Чернетка онбордингу церкви для Twilio | Запропоновані налаштування форми реєстрації B1, приклади кампаній для конкретних церков і контрольні списки погодження та експлуатації |