Перейти к основному содержимому

Архитектура

Эти страницы представляют собой межрепозиторные карты систем. Они описывают, как работает основная система 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)

Два структурных правила определяют всё, что описано в этом разделе:

  1. Модули изолированы. Каждый модуль Api владеет своей базой данных и своими таблицами. Другие модули и приложения получают доступ к его данным только через его REST-эндпоинты. См. Структура модуля.
  2. Общий код поставляется как 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, вебхуки, провайдеры контента, MCPApi, общие библиотеки, внешние приложения
Журнал аудита и отменяемые пакетные операцииАудит каждого изменения по умолчанию на уровне контроллера и слой пакетных операций, благодаря которому импорт и массовые действия можно отменитьApi (все модули), B1Admin, B1Transfer
MinistryStuffПлатный сервис хранилища и кредитов на SMS: идентификация через общий JWT, сервисный ключ для обмена между серверами, точки подключения провайдеров SMS и хранилища, биллинг StripeMinistryStuffApi, MinistryStuffWeb, Api (content + messaging), пакеты texting/apihelper, B1Admin
Собственное хранилище (BYOS)Церкви подключают Google Drive, Dropbox, OneDrive или S3-совместимый бакет для загрузок сверх бесплатных 100 МБ: подключение через OAuth, схемы загрузки для каждого провайдера, публичное перенаправление на скачиваниеApi (content + membership), пакеты helpers/apphelper, B1Admin, B1App
Общий контентОбщая основа ресурсов и заявок для пользовательского контента, который используется в нескольких продуктах, и единая очередь модерации только для сотрудников в серверной администрации B1AdminApi (модуль commons), B1Admin, WorshipCommons, Lessons.church, FreeShow
Совет

Если изменение меняет работу одной из этих систем, а не только отдельной страницы в одном приложении, соответствующую карту системы здесь нужно обновить в той же работе. Так этот раздел остаётся надёжной отправной точкой для новых участников.

Предложения​

В этих документах описаны предлагаемые работы, которые ожидают рассмотрения. Они не описывают доступное сейчас поведение продукта.

ПредложениеЧто описано
Twilio BYOKАккаунт, ключи, сервис и номер телефона, принадлежащие церкви; объём интеграции, согласие, доставка, оценки и проверки перед выпуском
Черновик подключения церкви к TwilioПредлагаемые настройки формы регистрации B1, примеры кампаний для отдельных церквей и контрольные списки для одобрения и эксплуатации