uvicorn-poetry-fastapi-project-template

(★ 102)

Cookiecutter project template for starting a FastAPI application. Runs in a Docker container with Uvicorn ASGI server on Kubernetes. Supports AMD64 and ARM64 CPU architectures.

파일 탐색기

최종 버전 다운로드 (.zip)

- - pipeline.yml
- dependabot.yml
- post_gen_project.py
- __init__.py
- conftest.py
- constants.py
- test_custom_config.py
- test_default_config.py
- test_docker_image_build.py
- test_tools.py
- - __init__.py
  - main.py
- - __init__.py
  - conftest.py
- .dockerignore
- .gitignore
- .pre-commit-config.yaml
- Dockerfile
- pyproject.toml
- README.md
.gitignore
.pre-commit-config.yaml
cookiecutter.json
LICENSE
poetry.lock
pyproject.toml
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/max-pfeiffer/uvicorn-poetry-fastapi-project-template

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd uvicorn-poetry-fastapi-project-template

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker build --tag my-application:1.0.0 .

Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.

docker run -it --rm my-application:1.0.0

빌드된 이미지를 실제 컨테이너로 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Python

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).

cookiecutter https://github.com/max-pfeiffer/uvicorn-poetry-project-template

이 명령어를 터미널에 그대로 입력해 실행하세요.

poetry install

pyproject.toml에 명시된 라이브러리를 설치합니다.

poetry run uvicorn --workers 1 --host 0.0.0.0 --port 8000 app.main:app

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.