kelvinducray / fastapi-orders-api Public

Notifications You must be signed in to change notification settings
Fork 0
Star 1

A simple product orders API to demonstrate various engineering skills.

1 star 0 forks Branches Tags Activity

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 10 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
dockerfiles		dockerfiles
orders-api		orders-api
postgres		postgres
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
docker-compose.yml		docker-compose.yml
release.sh		release.sh

Repository files navigation

FastAPI Orders API

An application to keep track of incoming orders.

Skills to demonstrate:

Python:
- FastAPI
- OOP
- Async programming
- SQL Alchemy (+ ORM usage)
- Language best practices
  - Unit Testing
  - Type checking
  - Linting
Docker (and Docker Compose)
Database usage (PostgreSQL)
Git
CI/CD
- Github + Heroku

To-dos:

Create a diagram mapping the database
Logging config yaml
Complete app
Get CI/CD up and running
Add build passing badge
Unit testing
Add to and expand list of skills demonstrated

Potential to-dos:

Some slight project restructuring
.dockerignore
Different dev & prod deployments
Multistage Docker build