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