speedyman08 / todo-app

Simple todo application backend written in Nest that aims to widen my understanding of Docker and Postgres

Todo app

Simple todo application backend written in Nest that aims to widen my understanding of Docker and Postgres. Very unfinished

Prerequisites

• Docker

How to run

• Create a .env file containing 3 environment variables (you can check the .env.example file to see how the DATABASE_URL variable is formatted):
  • POSTGRES_USER
  • POSTGRES_PASSWORD
  • DATABASE_URL
• Run "docker compose up -d", this will create a postgres database container using the environment variables you supplied, and another container for the API. The API has the port "3000" exposed.

Functionality

• The only endpoint that this API has is /todo, and you can only make a POST request to it currently. This is what the body for that request looks like

{
    "instruction": "This is the instruction",
    "description": "This is the description"
}

Technologies used