clean-architecture-fastapi-project-template
Clean architecture FastAPI project template
파일 탐색기
최종 버전 다운로드 (.zip)- pull_request_template.md
- installation.rst
- quickstart.rst
- environment-variables.rst
- makefile-commands.rst
- architecture.rst
- changelog.rst
- conf.py
- index.rst
- license.rst
- Makefile
- README.md
- requirements.txt
- post_gen_project.py
- docker.md
- environment.md
- migrations.md
- mypy-usage.md
- ruff-usage.md
- init-db.sh
- init-db.sql
- init-mysql.sql
- init-sqlite.sh
- migrate.sh
- setup-env.sh
- __init__.py
- artifact.py
- __init__.py
- cache.py
- db_mapper.py
- http_clients.py
- mappers.py
- message_broker.py
- repositories.py
- serialization.py
- uow.py
- __init__.py
- fetch_artifact_from_museum_api.py
- get_artifact_from_cache.py
- get_artifact_from_repo.py
- process_artifact.py
- publish_artifact_to_broker.py
- publish_artifact_to_catalog.py
- save_artifact_to_cache.py
- save_artifact_to_repo.py
- __init__.py
- exceptions.py
- mappers.py
- __init__.py
- di.py
- providers.py
- __init__.py
- app.py
- base.py
- broker.py
- cors.py
- database.py
- external_apis.py
- logging.py
- redis.py
- settings.py
- __init__.py
- artifact.py
- __init__.py
- __init__.py
- era.py
- material.py
- __init__.py
- exceptions.py
- __init__.py
- publisher.py
- __init__.py
- redis_client.py
- __init__.py
- artifact_db_mapper.py
- artifact_uow_mapper.py
- c3cca8a62218_initial_migration_create_artifacts_table.py
- __init__.py
- env.py
- script.py.mako
- __init__.py
- artifact.py
- __init__.py
- artifact.py
- __init__.py
- exceptions.py
- session.py
- uow.py
- uow_new.py
- __init__.py
- clients.py
- __init__.py
- artifact.py
- __init__.py
- __init__.py
- artifact_controller.py
- __init__.py
- artifact_mapper.py
- __init__.py
- responses.py
- __init__.py
- exceptions.py
- routers.py
- __init__.py
- error_handling.py
- middlewares.py
- __init__.py
- __init__.py
- __init__.py
- __init__.py
- main.py
- __init__.py
- test_process_artifact.py
- __init__.py
- __init__.py
- test_artifact.py
- __init__.py
- test_era.py
- __init__.py
- __init__.py
- test_artifact_model.py
- __init__.py
- __init__.py
- __init__.py
- test_api_integration.py
- __init__.py
- test_artifact_controller.py
- __init__.py
- __init__.py
- __init__.py
- conftest.py
- factories.py
- faker.py
- .dockerignore
- .git-commit-template
- .gitignore
- .pre-commit-config.yaml
- alembic.ini
- docker-compose.override.yml
- docker-compose.yml
- Dockerfile
- env.template
- Makefile
- pyproject.toml
- README.md
- .cookiecutterignore
- .editorconfig
- .gitignore
- .readthedocs.yaml
- CONTRIBUTING.md
- cookiecutter.json
- DOCUMENTATION.md
- LICENSE
- README.md
- renovate.json
# 설치 가이드
git clone https://github.com/Peopl3s/clean-architecture-fastapi-project-template
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd clean-architecture-fastapi-project-template
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. 공식 설치 스크립트
쉬움 추천- Python 3 pip 명령어를 쓰려면 Python이 필요합니다.
pip install --dependency-group dev
PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
3. Docker
쉬움- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
make dev-setup-docker
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
make docker-up-dev
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
├── docker-compose.yml # Docker services
compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.
make docker-test # Run tests in Docker
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
make docker-build # Build Docker image
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
4. Python
쉬움pip install -r requirements.txt
requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.
pip install -e .
requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.
pip install --dependency-group dev
PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.
pip install -e ".[dev]"
requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.
pip list
이 명령어를 터미널에 그대로 입력해 실행하세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
5. Make
보통- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.
make dev-setup-docker
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
make docker-up-dev
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
make html
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
make lint # Run linter
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
make lint-fix # Fix linting issues
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.