First, you need to download the project from github and bootstrap your environment.
git clone https://github.com/dt50/Fastapi-Notebook
cd Fastapi-Notebook
poetry install
poetry shell
In app/core/config
you need to change to your database url.
Template url - postgres://username:password@host:port/db
After then you can up your uvicorn server with command
uvicorn app.main:app --reload
To start with docker you need to run command
git clone https://github.com/dt50/Fastapi-Notebook
cd Fastapi-Notebook
poetry install
poetry export --without-hashes -f requirements.txt | sed 's/-e //' > requirements.txt
docker-compose up --build
All routes available on /docs
or /redoc
paths with Swagger or ReDoc.
Files related to application are in the app. Application parts are:
app
├── api
│ ├── dependencies
│ ├── errors
│ └── routes
├── core
├── db
│ ├── migrations
│ ├── queries
│ └── repositories
└── models
└── schemas