Project Template

Want to build a new API server but dont know where to start? Looking to learn an awesome new framework? Need a backend stack to quickly develop an API for your new project?

This project provides you an out of the box API service that demonstrates the wonders of FastApi. This codebase provides the needed basics and some useful goodies out of the box. Simply clone this repository and customize to your own needs and requirements!

Features

1. Backend service built in Fastapi
   • For more info on Fastapi, please checkout the docs. They are great!
2. Restful API with sample endpoints
3. Schema validation with Pydantic
4. Extendable CRUDBase class to easily configure crud operations
5. Object Relational Mapping with Sqlalchemy
6. Postgresql database running in docker with sample data

Getting Started

The following are instructions on how to setup the projects to run and develop. Source code is available in the app folder.

Requirements

1. Python 3.12 or greater
   • python3.XX-venv for virtual environment
2. Docker for postgresql container

Setup

1. Create a virtual environment python3 -menv venv ./venv/
2. Activate env and install requirements
   • source venv/bin/activate
   • pip install -r requirements.txt
3. Setup database
   • Start docker container docker compose up -d
   • Setup and populate sample data python3 ./scripts/populate_db.py

Running

1. Run database container docker compose up -d
2. Start fast app fastapp dev
3. Take a look at the api spec http://localhost:8000/docs

Future Additions

• Cleaner setup script
• Run app in docker container
• Authentication
  • Certain db access per user
  • only see own salaries/if admin
• Testing
• Error handling
• Logging
• db session pool
• pagination

License

This project is licensed under the terms of the MIT license.