설정
이 섹션에서는 ChurchApps 프로젝트를 위한 로컬 개발 환경을 설정하는 방법을 안내합니다. 빠른 개발을 위해 프론트엔드가 공유 데모 API를 바라보도록 하거나, 백엔드 작업을 위해 전체 스택을 로컬에서 실행할 수 있습니다.
두 가지 방법
필요한 스택의 범위에 따라 로컬에서 개발하는 방법은 두 가지가 있습니다.
1. 데모 API 사용 (가장 쉬움)
프론트엔드 프로젝트(웹 앱, 모바일 앱 또는 데스크톱 앱)를 작업하는 경우, 가장 빠른 방법은 로컬 앱이 공유 데모 API를 바라보도록 하는 것입니다. 데이터베이스나 백엔드 설정이 필요하지 않습니다.
데모 API의 기본 URL은 다음과 같습니다:
https://api.demo.churchapps.org
각 API 모듈은 이 기본 URL 아래의 경로에서 사용할 수 있습니다. 예를 들면 다음과 같습니다:
https://api.demo.churchapps.org/membership
https://api.demo.churchapps.org/attendance
https://api.demo.churchapps.org/giving
데모 환경은 main의 최신 코드를 실행하며, 샘플 데이터는 매일 밤 다시 채워집니다. 따라서 그곳에 만든 내용은 오래 남지 않는다고 생각하세요. (이전 스테이징 환경인 api.staging.churchapps.org는 더 이상 운영되지 않습니다. 일부 샘플 .env 파일에는 아직 스테이징 URL이 적혀 있을 수 있으니, 데모 또는 로컬 URL로 교체하세요.)
이 방법을 사용하면 몇 분 안에 프론트엔드 변경 작업을 시작할 수 있습니다. 대부분의 기여자에게 권장되는 방법입니다.
2. 모든 것을 로컬에서 실행
API 코드를 수정하거나 오프라인에서 작업해야 한다면 전체 스택을 로컬에서 실행할 수 있습니다. 이를 위해서는 MySQL 8.0 이상과 추가 설정이 필요합니다. 자세한 안내는 API 로컬 설정 가이드를 참조하세요.
시작하기
다음 페이지를 순서대로 따라 하세요:
- 사전 요구 사항 -- 필요한 도구(Node.js, Git, MySQL 등)를 설치합니다
- 프로젝트 개요 -- 어떤 프로젝트가 있고 각각 무엇을 하는지 이해합니다
- 환경 변수 --
.env파일을 설정하여 모든 구성 요소를 서로 연결합니다
각 ChurchApps 프로젝트는 독립된 Git 저장소입니다. 작업하려는 특정 프로젝트만 클론하면 됩니다.