turall/fastapi-boilerplate

Project template for python FastApi

FastApi BoilerPlate

Repo is useful for simple and fast development to production with FastApi. Framework is the one of the asynchronous framework for Python, for documation please refer to FastAPI

Notes

FastAPI boilerplate supports Python version 3.5 and above. This boilerplate is using Gino-ORM for database connections and queries.

In order to use boilerplate for development we suggest you followings:

🕹 Guide

You can either use pipenv or pip itself

For development with pipenv:

pipenv shell

pipenv install or pip install -r requirements.txt

For development with pip:

python3 -m venv .venv

source .venv/bin/activate

pip install -r requirements.txt

Check this file and modife accordingly .env

source .env

For database migrations:

alembic revision --autogenerate

alembic upgrade heads

Last but not the least do the followings the you are ready to go:

uvicorn app.main:app --reload

add .env to gitignore

rm -rf .git

Other FastAPI project templates

full-stack-fastapi-postgresql

full-stack-fastapi-couchbase

cookiecutter-spacy-fastapi

fast-api-project-template

startapp

fastapi-nano

Contributing

Fell free to open issue and send pull request.

Supported OS

Linux, MacOS