fastapi-genesis
FastAPI project Template generator to make your life easier ๐งฌ ๐
File Explorer
Download Latest Version (.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
# Installation Guide
1. Get the code
git clone https://github.com/Lolomgrofl/fastapi-genesis
Downloads the entire project code from GitHub to your computer.
cd fastapi-genesis
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip install cookiecutter
Installs the package published on PyPI directly โ no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
โโโ docker-compose.yml <- Docker compose configuration file
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
4. Python
EasyPrerequisites
pip install cookiecutter
Installs the package published on PyPI directly โ no need to clone the source.
โโโ pyproject.toml <- Python dependencies for Poetry (see https://python-poetry.org/)
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
5. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd {{cookiecutter.repo_name}}
This project's files live in a subfolder, so move into it first.
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)