README.md

Invoice app

This is an invoice demo project template that uses FastAPI, Alembic and async SQLModel as ORM. It shows a complete async CRUD template with multiple relationships between one table.

Database design

FastAPI Swagger UI

Features

1. invoice number
2. client contact information
3. invoice contact information
4. invoice items(name, description, quantity, price)
5. total price
6. multiple notes on each invoice

Project Setup

1. Create database

   mysql> CREATE DATABASE invoice_db;

2. Create a dev.env file in the envs directory and set variables as in the dev.example.env file

3. Run the app using this make command

   make run

4. Run Super admin APIs

   • Create database
   • Upgrade migration to head

5. Done!, give a try to call APIs right from swagger