FastAPI Minimalistic Template

This template requires python>=3.7 and is based on orrshilon/fastapi-mini-template

Description

This is a minimalistic and extensible FastAPI template.

Quickstart

Docker Compose

1. Copy .env.sample to .env
2. Run docker compose

   docker compose up -d

Locally

1. Copy .env.sample to .env
2. Create a virtual environment
3. Install the dependencies

   pip install -r requirements.txt && pip install -r requirements-dev.txt

4. Start the app

   uvicorn app.main:app --port 8080 --reload

   or

    PYTHONPATH=$PWD python3 app/main.py

API Documentation

http://localhost:8080/docs

Development

Linting

make lint

Other Commands

make help