fastapi-genesis
FastAPI project Template generator to make your life easier 𧬠π
νμΌ νμκΈ°
μ΅μ’ λ²μ λ€μ΄λ‘λ (.zip)- FUNDING.yml
- .gitkeep
- release.yml
- .gitkeep
- env.py
- README
- script.py.mako
- __init__.py
- base.py
- user.py
- __init__.py
- base.py
- user.py
- __init__.py
- api_router.py
- user.py
- __init__.py
- token.py
- user.py
- __init__.py
- user.py
- utils.py
- __init__.py
- db.py
- main.py
- settings.py
- autogenerate.sh
- downgrade.sh
- welcome.txt
- __init__.py
- .env
- .gitignore
- .pre-commit-config.yaml
- alembic.ini
- docker-compose.yaml
- Dockerfile
- Makefile
- pyproject.toml
- README.md
- .gitignore
- .pre-commit-config.yaml
- cookiecutter.json
- LICENSE
- README.md
# μ€μΉ κ°μ΄λ
git clone https://github.com/Lolomgrofl/fastapi-genesis
κΉνλΈμμ νλ‘μ νΈ μ½λ μ 체λ₯Ό λ΄ μ»΄ν¨ν°λ‘ λ΄λ €λ°μ΅λλ€.
cd fastapi-genesis
λ°©κΈ λ΄λ €λ°μ νλ‘μ νΈ ν΄λ μμΌλ‘ μ΄λν©λλ€.
2. 곡μ μ€μΉ μ€ν¬λ¦½νΈ
μ¬μ μΆμ²- Python 3 pip λͺ λ Ήμ΄λ₯Ό μ°λ €λ©΄ Pythonμ΄ νμν©λλ€.
pip install cookiecutter
PyPIμ λ°°ν¬λ ν¨ν€μ§λ₯Ό λ°λ‘ μ€μΉν©λλ€. μμ€ ν΄λ‘ μ΄ νμ μμ΅λλ€.
μ΄ λ ν¬μ READMEμ μ ν μ€μ λͺ λ Ήμ΄λ₯Ό κ·Έλλ‘ κ°μ Έμμ΅λλ€.
3. Docker
μ¬μ- Git GitHubμμ νλ‘μ νΈ μ½λλ₯Ό λ΄λ €λ°μΌλ €λ©΄ νμν©λλ€.
- Docker Desktop 컨ν μ΄λλ₯Ό λΉλνκ³ μ€ννλ €λ©΄ νμν©λλ€. μ€μΉ ν μ€νν΄μ λ°±κ·ΈλΌμ΄λμ μΌλμΈμ.
βββ docker-compose.yml <- Docker compose configuration file
compose μ€μ νμΌμ μ μλ μλΉμ€λ€μ λμμΌλ‘ λͺ λ Ήμ μ€νν©λλ€.
μ΄ λ ν¬μ READMEμ μ ν μ€μ λͺ λ Ήμ΄λ₯Ό κ·Έλλ‘ κ°μ Έμμ΅λλ€.
4. Python
μ¬μpip install cookiecutter
PyPIμ λ°°ν¬λ ν¨ν€μ§λ₯Ό λ°λ‘ μ€μΉν©λλ€. μμ€ ν΄λ‘ μ΄ νμ μμ΅λλ€.
βββ pyproject.toml <- Python dependencies for Poetry (see https://python-poetry.org/)
νμ΄μ¬ μ€ν¬λ¦½νΈ(λλ λͺ¨λ)λ₯Ό μ€νν©λλ€.
μ΄ λ ν¬μ READMEμ μ ν μ€μ λͺ λ Ήμ΄λ₯Ό κ·Έλλ‘ κ°μ Έμμ΅λλ€.
5. Make
보ν΅- Git GitHubμμ νλ‘μ νΈ μ½λλ₯Ό λ΄λ €λ°μΌλ €λ©΄ νμν©λλ€.
- Make Linux/macOSλ λ³΄ν΅ κΈ°λ³Έ μ€μΉλμ΄ μμ΅λλ€. Windowsλ λ³λ μ€μΉ(μ: MSYS2, WSL)κ° νμν©λλ€.
cd {{cookiecutter.repo_name}}
μ΄ νλ‘μ νΈμ κ΄λ ¨ νμΌμ΄ νμ ν΄λ μμ μμ΄μ, λ¨Όμ κ·Έ ν΄λλ‘ μ΄λν©λλ€.
make
μμ±λ λΉλ μ€μ μ λ°νμΌλ‘ μ€μ μ»΄νμΌμ μ§νν΄ μ€ν νμΌμ λ§λλλ€.
