diff --git a/README.md b/README.md index c7181f4..de9f5d8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,68 @@ -# backend-python +# 다양성 평가 리포트 웹사이트 백엔드 + ![CD Status](https://github.com/NewWays-TechForImpactKAIST/backend-python/actions/workflows/build-dev-image.yaml/badge.svg) + +FastAPI로 개발되는 다양성 평가 리포트 웹사이트의 백엔드 레포지토리입니다. + +## Docs + +본 프로젝트는 Swagger를 사용하여 API 문서를 작성하고 있습니다. +[Swagger](https://diversity-api.tech4impact.kr/docs) 에서 API Endpoints 들을 확인하고 테스트 할 수 있습니다. + +## Setup + +이 프로젝트를 실행하기 위해서는 Python(v3.9 이상)이 설치되어 있어야 합니다. + +### 개발환경 설정 과정 + +1. 파이썬 가상환경 생성 + - 아래 명령을 실행하여 파이썬 가상환경을 생성합니다. + ```bash + cd ~ && virtualenv newways --python=3.10 + ``` +2. 가상환경 활성화 + - 아래 명령을 실행하여 가상환경을 활성화합니다. + ```bash + source ~/newways/bin/activate + ``` +3. 레포지토리 클론 + - 아래 명령을 실행하여 레포지토리를 클론합니다. + ```bash + git clone https://github.com/NewWays-TechForImpactKAIST/backend-python + ``` +4. 필요한 패키지 설치 + - requirements.txt에 명시된 패키지를 설치합니다. + ```bash + pip install -r requirements.txt + ``` +5. 환경 변수 설정 + - `.env.example` 파일을 복사하여 `.env` 파일을 생성합니다. + ```bash + cp .env.example .env + ``` + - `.env` 파일을 열어 환경변수를 필요에 따라 변경합니다. +6. uvicorn 실행 + - uvicorn을 사용해 fastapi를 실행합니다. + ```bash + uvicorn main:app --host HOST --port PORT + ``` + +### 배포 과정 + +이 레포의 main 브랜치에 새 커밋이 생성될 때마다, GitHub Actions를 통해 배포용 Docker 이미지가 빌드됩니다. +이 Docker 이미지를 사용하여 서비스를 배포할 수 있습니다. + +1. 환경변수 설정 + - `.env.example` 파일을 복사하여 `.env` 파일을 생성합니다. + ```bash + cp .env.example .env + ``` + - `.env` 파일을 열어 환경변수를 필요에 따라 변경합니다. + +2. 백엔드 컨테이너 배포 + - 컨테이너를 아래 명령으로 생성합니다. + ```bash + docker-compose -f docker-compose.dev.yml up -d + ``` + - `newways-watchtower`는 1분에 한 번씩 새 백엔드 이미지가 있는지 확인하여, 백엔드 컨테이너를 주기적으로 업데이트하는 역할을 수행합니다. +