fastapi-template

(★ 249)

A Configurable template for a FastAPI application, with Authentication, User integration, Caching, Logging, Admin pages and a snappy CLI to control it all!

파일 탐색기

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

- - bug_report.md
  - feature_request.md
- - codeql.yml
  - dependency-review.yml
  - mypy.yml
  - prek.yml
  - ruff.yml
  - tests.yml
- CODEOWNERS
- FUNDING.yml
- renovate.json
- settings.json
- - __init__.py
  - admin.py
  - auth.py
  - models.py
- - __init__.py
  - constants.py
  - decorators.py
  - invalidation.py
  - key_builders.py
- - __init__.py
  - custom.py
  - db.py
  - dev.py
  - docs.py
  - keys.py
  - test.py
  - user.py
- - __init__.py
  - helpers.py
  - log_config.py
  - metadata.py
  - openapi.py
  - settings.py
- - __init__.py
  - db.py
  - helpers.py
- - __init__.py
  - api_key.py
  - auth.py
  - email.py
  - helpers.py
  - security.py
  - user.py
- - __init__.py
  - custom.py
  - instrumentator.py
  - namespace.py
- - __init__.py
  - cache_logging.py
  - logging_middleware.py
- - env.py
  - README
  - script.py.mako
- - __init__.py
  - api_key.py
  - enums.py
  - user.py
- - __init__.py
  - config.py
  - decorators.py
  - handlers.py
- - __init__.py
  - api_key.py
  - auth.py
  - config_error.py
  - heartbeat.py
  - home.py
  - routes.py
  - user.py
- - __init__.py
  - base.py
  - email.py
  - examples.py
  - password.py
- - index.html
  - password_reset_form.html
  - password_reset_success.html
- __init__.py
- api_admin.py
- logs.py
- main.py
- create-test-db.sh
- - extra.css
- - meta.md
  - templates.md
- - deployment.md
- - docker.md
  - documentation.md
  - local.md
- - __init__.py
  - google_style_notes.py
- - api.md
  - swagger.md
- - add-user.md
  - admin-panel.md
  - api-keys.md
  - caching.md
  - installation.md
  - metrics.md
  - rate-limiting.md
  - user-control.md
  - user-management.md
- changelog.md
- contributing.md
- future.md
- important.md
- index.md
- license.md
- project-organization.md
- quick-start.md
- troubleshooting.md
- tutorials.md
- docker-compose.yml
- prometheus.yml
- docker-compose.yml
- - html_index.png
- favicon.ico
- site.css
- - __init__.py
  - test_cli_create_user.py
  - test_cli_custom_command.py
  - test_cli_db_command.py
  - test_cli_db_seed.py
  - test_cli_docs_command.py
  - test_cli_keys_command.py
  - test_cli_main.py
  - test_cli_test_command.py
  - test_cli_user_command.py
  - test_gatekeeper.py
- - __init__.py
  - test_admin_routes.py
  - test_api_key_routes.py
  - test_auth_routes.py
  - test_cache.py
  - test_home_routes.py
  - test_metrics_endpoint.py
  - test_password_recovery.py
  - test_protected_user_routes.py
  - test_rate_limit_metrics.py
  - test_rate_limit_redis.py
  - test_rate_limiting.py
  - test_user_routes.py
- - __init__.py
  - test_admin.py
  - test_api_key_auth.py
  - test_api_key_manager.py
  - test_auth_manager.py
  - test_auth_manager_helpers.py
  - test_cache.py
  - test_catch_all.py
  - test_config_helpers.py
  - test_cors_config.py
  - test_database.py
  - test_database_helpers.py
  - test_email_manager.py
  - test_instrumentator.py
  - test_jwt_auth.py
  - test_lifespan.py
  - test_logging.py
  - test_logging_helpers.py
  - test_manager_helpers.py
  - test_model.py
  - test_openapi.py
  - test_password_helpers.py
  - test_password_reset_url_encoding.py
  - test_rate_limit_config.py
  - test_rate_limit_helpers.py
  - test_rate_limit_init.py
  - test_security.py
  - test_user_manager.py
  - test_validation.py
- __init__.py
- _constants.py
- conftest.py
- helpers.py
.dockerignore
.env.example
.gitignore
.markdownlint.json
.pre-commit-config.yaml
.pylintrc
alembic.ini
alembic_scripting.ini
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
docker-compose.yml
Dockerfile
LICENSE.txt
mkdocs.yml
pyproject.toml
README.md
requirements-dev.txt
requirements.txt
SECURITY-REVIEW.md
SECURITY.md
TODO.md
uv.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/seapagan/fastapi-template

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

cd fastapi-template

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

2. Docker

쉬움 추천

사전 준비물

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

docker compose up

정의된 모든 컨테이너(서버, DB 등)를 한 번에 빌드하고 백그라운드에서 실행합니다.

docker compose up --build

정의된 모든 컨테이너(서버, DB 등)를 한 번에 빌드하고 백그라운드에서 실행합니다.

docker compose down

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

docker compose run --rm api alembic upgrade head

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

docker compose run --rm --service-ports api uvicorn --host 0.0.0.0 main:app --reload

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

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

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

3. Python

쉬움

사전 준비물

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

pip install -r requirements.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

파이썬 스크립트(또는 모듈)를 실행합니다.

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