Архитектура
Эти страницы представляют собой межрепозиторные карты систем. Они описывают, как работает основная система ChurchApps от начала до конца: через приложения, модули API и общие библиотеки. Они не объясняют настройку отдельного проекта. Прочитайте их перед изменением поведения системы. Чтобы запустить проект, используйте Установку, а для справочника по конечным точкам API обращайтесь к разделу API.
Экосистема в общих чертах
ChurchApps состоит примерно из 20 независимых репозиториев (это не монорепозиторий). Клиентские приложения обмениваются данными с небольшим набором серверных 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), все веб-приложения |
| Push-уведомления в браузере | Канал push-уведомлений в браузере: ключи VAPID, хранение подписок, доставка | Api (messaging), все веб-приложения |
| Пожертвования | Платёжные провайдеры и шлюзы, потоки пожертвований, фонды и пакеты платежей, вебхуки шлюзов | Api (giving), apphelper, B1App, B1Admin |
| Регистрации на события | Модель коммерции для регистраций: типы участников, выборы, промокоды, платежи через шлюз пожертвований и лист ожидания | Api (content + giving), B1App, B1Admin |
| Check-in | Регистрация на киоске и самостоятельный check-in, модель данных посещаемости, маршрутизация по комнатам, защита детей, печать этикеток | B1Checkin, B1App, B1Admin, Api (attendance + membership) |
| Конструктор сайтов | Дерево страниц, секций и элементов, контракт типов элементов и их рендереры, блог, страницы с ограниченным доступом, SEO и генерация с помощью ИИ | Api (content), AskApi, helpers/apphelper, B1Admin, B1App |
| Маршрутизация сайтов и несколько сайтов | Как запрос определяет церковь и конкретный сайт, модель данных с несколькими сайтами через siteId и пограничный уровень Caddy для собственных доменов | B1App, Api (membership + content), B1Admin |
| Интеграции | Точки расширения: OAuth, ключи API, вебхуки, провайдеры контента, MCP | Api, общие библиотеки, внешние приложения |
| Журнал аудита и отменяемые пакетные операции | Аудит каждого изменения по умолчанию на уровне контроллера и слой пакетных операций, благодаря которому импорт и массовые действия можно отменить | Api (все модули), B1Admin, B1Transfer |
| MinistryStuff | Платный сервис хранилища и кредитов на SMS: идентификация через общий JWT, сервисный ключ для обмена между серверами, точки подключения провайдеров 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 |
| Общий контент | Общая основа ресурсов и заявок для пользовательского контента, который используется в нескольких продуктах, и единая очередь модерации только для сотрудников в серверной администрации B1Admin | Api (модуль commons), B1Admin, WorshipCommons, Lessons.church, FreeShow |
Если изменение меняет работу одной из этих систем, а не только отдельной страницы в одном приложении, соответствующую карту системы здесь нужно обновить в той же работе. Так этот раздел остаётся надёжной отправной точкой для новых участников.
Предложения
В этих документах описаны предлагаемые работы, которые ожидают рассмотрения. Они не описывают доступное сейчас поведение продукта.
| Предложение | Что описано |
|---|---|
| Twilio BYOK | Аккаунт, ключи, сервис и номер телефона, принадлежащие церкви; объём интеграции, согласие, доставка, оценки и проверки перед выпуском |
| Черновик подключения церкви к Twilio | Предлагаемые настройки формы регистрации B1, примеры кампаний для отдельных церквей и контрольные списки для одобрения и эксплуатации |