A FastAPI based low code starter/boilerplate: SQLAlchemy 2.0 (async), Postgres, React-Admin, pytest and cypress
MIT License
A FastAPI based starter that relies heavily on existing plugins/frameworks. Integrates with OpenAPI Generator for a Typescript client, FastAPI Users for authentication, async-first with SQLAlchemy 2.0.
You need Python 3 and pip installed locally. Run the cookiecutter command (at least 1.7) and you'll be asked a few prompts.
pip3 install cookiecutter
cookiecutter https://github.com/gaganpreet/fastapi-starter
The generator (cookiecutter) will ask you for some data, you might want to have at hand before generating the project.
The input variables, with their default values [default value], are:
project_name
: The name of the projectproject_slug
: The development-friendly name of the project. By default, based on the project name.backend_port
: The backend port on the localhost.front_end_port
: The frontend port on the localhost.If you want to keep up to date with upstream changes (i.e. changes in this template), then it's better to use Cruft, which is fully compatible with Cookiecutter.
pip3 install cruft
cruft create https://github.com/gaganpreet/fastapi-starter
Using cruft will generate a metadata file named .cruft.json
(don't delete it). Later on you can update to the current version of this cookiecutter and import the changes to your generated project by running this command:
cruft update
The following features were left out in favour of simplicity:
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!