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
์์ฑ๋ ๋น๋ ์ค์ ์ ๋ฐํ์ผ๋ก ์ค์ ์ปดํ์ผ์ ์งํํด ์คํ ํ์ผ์ ๋ง๋ญ๋๋ค.
