Настройка
Этот раздел проведёт вас через настройку локальной среды разработки для проектов ChurchApps. Вы можете либо направить фронтенд на общие staging API для быстрой разработки, либо запустить весь стек локально для работы над бэкендом.
Два подхода
Существует два способа разработки локально, в зависимости от того, какая часть стека вам нужна:
1. Направить на staging API (самый простой)
Если вы работаете над фронтенд-проектом (веб-приложение, мобильное приложение или настольное приложение), самый быстрый путь — направить локальное приложение на общие staging API. Настройка базы данных или бэкенда не требуется.
Базовый URL staging API:
https://api.staging.churchapps.org
Каждый модуль API доступен по пути под этой базой, например:
https://api.staging.churchapps.org/membership
https://api.staging.churchapps.org/attendance
https://api.staging.churchapps.org/giving
Этот подход позволяет начать вносить изменения во фронтенд за считанные минуты. Это рекомендуемый путь для большинства участников.
2. Запустить всё локально
Если вам нужно изменять код API или работать автономно, вы можете запустить весь стек локально. Для этого требуется MySQL 8.0+ и дополнительная настройка. Подробные инструкции см. в руководстве по локальной настройке API.
Начало работы
Следуйте этим страницам по порядку:
- Предварительные требования -- Установите необходимые инструменты (Node.js, Git, MySQL и т.д.)
- Обзор проектов -- Узнайте, какие проекты существуют и что они делают
- Переменные окружения -- Настройте файлы
.envдля соединения всех компонентов
Каждый проект ChurchApps является независимым Git-репозиторием. Вам нужно клонировать только те проекты, над которыми вы хотите работать.