To-do List API

About this project

The To-do List Project is a fullstack project made in early 2021.

This backend project is deployed on Heroku.

If you want to take a look on the frontend project made with React, follow this link : To-do-List React app

Packages & libraries used :

• express
• express-formidable
• mongoose
• twilio
• crypto-js
• uid2

Routes documentation

/signup (POST)

Add a new user in database

Body	Type	Required
email	string	Yes
password	string	Yes
username	string	Yes

/signin (POST)

Log a user

Body	Type	Required
email	string	Yes
password	string	Yes

/create/board (POST)

Create a new board

Body	Type	Required
title	string	Yes

/boards (GET)

Get all boards of the user

/update/board/:id (PUT)

Update a board title

Body	Type	Required
title	string	Yes

Param	Required	Description
id	Yes	board id

/delete/board/:id

Delete a board and all tasks associated

Param	Required	Description
id	Yes	board id

/create/task (POST)

Create a new task

Body	Type	Required
title	string	Yes
boardId	string	Yes

/tasks/:boardId (GET)

Get all tasks of a board

Param	Required	Description
boardId	Yes	board id

/update/task/:id (PUT)

Update a task title or a task status

Body	Type	Required
title	string	No
done	boolean	No

Param	Required	Description
id	Yes	task id

/delete/task/:id (DELETE)

Delete a task

Param	Required	Description
id	Yes	task id

Install and run project

You will need node and yarn or npm installed globally on your machine.

Clone this repository :

git clone https://github.com/Corinne-Coding/To-do-List-express-API.git
cd To-do-List-express-API

Install packages with yarn or npm :

yarn

or

npm install

When installation is complete, start the server :

npx nodemon