/coffee-api

A simple CRUD API for coffee recipes written with FastAPI

Primary LanguagePython

Coffee API

Simple CRUD API to create coffee brew recipes

API was built with FastAPI

How it works

All you need is a running Docker daemon. Then simply run the below:

docker-compose up -d --build

This will build and bring up the services for the CRUD API. Confirm that the app is up by accessing:

http://localhost:8080/health -> Returns an I am healthy message

Access the docs for the API by going to http://localhost:8080/docs

Migrations

Using alembic, we can easily run DB migrations. To run a new migration follow the below:

Navigate into src

cd src/

Then run Alembic revision command:

alembic revision -m 'My new migration'

This will generate a new migration file inside the coffee/version, edit this file and added the DB chnages.

For the changes to take effect, run:

cd .. && docker-compose down && docker-compose up -d --build

Connect to pgAdmin4

To view the DB, open Chrome as limited browsers are supported, then navigate to localhost:16543/ and login with username: admin@admin.com & password: test123!

Thereafter click on server -> create new server. Give the server a name, to find the hostname run:

ifconfig |grep inet

There will be an IP for our Docker network, use that as the hostname. The rest is simple, DB username and password is both postgres

To-do: