Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turall/fastapi-boilerplate
Project template for python FastApi
https://github.com/turall/fastapi-boilerplate
async fastapi fastapi-asyncgp-gino fastapi-template gino
Last synced: 2 months ago
JSON representation
Project template for python FastApi
- Host: GitHub
- URL: https://github.com/turall/fastapi-boilerplate
- Owner: Turall
- Created: 2020-01-29T10:08:49.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-16T12:53:18.000Z (over 3 years ago)
- Last Synced: 2024-10-18T22:21:24.724Z (3 months ago)
- Topics: async, fastapi, fastapi-asyncgp-gino, fastapi-template, gino
- Language: Python
- Size: 85 KB
- Stars: 44
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://fastapi.tiangolo.com/)
## Notes
FastAPI boilerplate supports Python version 3.5 and above.
This boilerplate is using [Gino-ORM](https://python-gino.org/) 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:
```sh
pipenv shell
pipenv install or pip install -r requirements.txt
```
For development with pip:
```sh
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
Check this file and modife accordingly .env
```sh
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](https://github.com/tiangolo/full-stack-fastapi-postgresql)
[full-stack-fastapi-couchbase](https://github.com/tiangolo/full-stack-fastapi-couchbase)
[cookiecutter-spacy-fastapi](https://github.com/microsoft/cookiecutter-spacy-fastapi)
[fast-api-project-template](https://github.com/bergran/fast-api-project-template)
[startapp](https://github.com/sabuhish/startapp)
[fastapi-nano](https://github.com/rednafi/fastapi-nano)
## Contributing
Fell free to open issue and send pull request.
## Supported OS
Linux, MacOS