본 repository는 개발환경의 편리한 설정을 위해 Github의 Codespace를 사용하였습니다.
따라서 Github Codespace 설명을 보고 개발/실행을 하는 것이 좋습니다.
또한 database와 같은 추가 어플리케이션을 연결하기 위해서 codespace의 devcontainer와 다른 어플리케이션을 나누었고, 이를 docker-compose file로 정의하였습니다.
이때, 데이터 베이스의 확인을 위하여 vscode의 확장을 사용하였습니다. 따라서 이 repository는 vscode로 개발하는 것을 추천합니다.
본 repository는 python 라이브러리의 설정을 위해서 Poetry를 사용하고 있습니다.
poetry install 을 이용하여 라이브러리 설정을 하시면 됩니다.
만약 Poetry가 생성한 인터프리터를 IDE에서 잡지못한다면,
poetry config virtualenvs.in-project true
poetry config virtualenvs.path "./.venv"
위의 두 명령어를 실행하고, 라이브러리 설정을 다시하면 됩니다.
해당 프로젝트는 fastapi라는 라이브러리를 사용합니다. 이때, 가상환경인 Poetry를 사용하므로, 조금 다른 명령어를 사용해야 합니다.
로컬에서 실행시키기 위해서 poetry run fastapi dev main.py를 사용합니다.
Production 설정을 켠 상태에서 실행시키기 위해서 poetry run fastapi run main.py를 사용합니다.