TodoList API

This is a simple TodoList API implemented using Docker, MySQL, SQL, Express, Node.js, TypeScript, Joi, Mocha, and Chai. This README provides a brief overview of the project and instructions for setup and testing.

Prerequisites

Before you begin, make sure you have the following tools and technologies installed on your system:

• Docker
• Node.js
• npm
• Git

Getting Started

1. Clone the repository to your local machine:

   git clone <repository-url>
   cd todo-list-api

2. Setup environment variables:

   touch .env

   copy and paste the .env.sample in to .env

3. Run docker:

   docker-compose up
   
   #or
   
   docker compose up

4. Enter api container:

   docker exec -it todo_list_api bash

5. Install project dependencies:

   npm i

6. Get the server up

   dev mode

   npm run dev

   build

   npm run start

Run tests

npm test

Thunder Client

Thunder Client is a easy method to make api requests inside of VSCode. It's pretty cool and simple.

To install just search for Thunder Client on the tab extensions on your VSCode then hit the install button.

To import collection do the following

Open the Thunder Client tab > Collections > Menu > Import > Choose the file thunder-collection_todos.json