Документация для разработчиков
ChurchApps — это набор из примерно 20 проектов с открытым исходным кодом, которые вместе образуют полноценную платформу для управления церковью. Проекты включают серверные API, веб-приложения, мобильные приложения, настольное приложение и общие библиотеки — все они написаны на TypeScript. Этот раздел содержит всё необходимое для настройки локальной среды разработки и начала участия в проекте.
Архитектура в общих чертах
Проекты представляют собой независимые репозитории (а не монорепозиторий). Общий код публикуется в npm под областью @churchapps/* и подключается как обычная зависимость. Это означает, что вы можете работать над одним проектом, не клонируя всю экосистему целиком.
Ключевые особенности:
- Язык: TypeScript во всех проектах
- Бэкенд: API на Node.js / Express, развёртываемые в AWS Lambda с помощью Serverless Framework
- Веб: React 19 (Vite и Next.js), Material-UI 7
- Мобильные приложения: React Native с Expo
- База данных: MySQL 8.0, по одной базе данных на каждый модуль API
Что охватывает этот раздел
- Настройка — Локальная среда разработки, предварительные требования и конфигурация
- Предварительные требования — Необходимые инструменты и программное обеспечение
- Обзор проектов — Все проекты в одном месте
- Переменные окружения — Настройка файлов
.env
- API — Локальная настройка основного API, инициализация базы данных и структура модулей
- Веб-приложения — Локальный запуск B1Admin, B1App и LessonsApp
- Мобильные приложения — Сборка B1Checkin и других приложений на Expo
- Общие библиотеки — Работа с Helpers, ApiHelper и AppHelper
- Развёртывание — Развёртывание API, веб-приложений и мобильных приложений
- Провайдер контента FreePlay — Интеграция вашей библиотеки уроков с FreePlay
Сообщество и ресурсы
| Ресурс | Ссылка |
|---|---|
| Организация на GitHub | github.com/ChurchApps |
| Трекер задач | ChurchAppsSupport Issues |
| Сообщество в Slack | Присоединиться к Slack |
Самый быстрый способ начать участвовать в разработке — выбрать веб-приложение (например, B1Admin), подключить его к общим демо-API и начать вносить изменения во фронтенд. Настройка базы данных или API не требуется.