Notes App

A note taking application that exposes a RESTful webservice interface which allows users be able to create simple notes.

Running the API

Build the images and run the containers:

make bootstrap

Read the API Documentation on here

Automated Tests

Ensure api container is running the run automated integrated tests with

$ docker exec -it notes-api pytest

Built With

The project has been built with the following technologies so far:

• FastAPI - FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
• PostgreSQL - A production-ready relational database system emphasizing extensibility and technical standards compliance.
• Pydantic - A data validation and settings management tool using python type annotations.