TODO APP BACKEND

This project represents my attempt at the HNG Premium Coding challenge.

Objective

Develop a RESTful API that enables users to create, read, update, and delete (CRUD) tasks in a task management system. Emphasise error handling, authentication, and scalability throughout the development process.

TECH STACK

This solution to the challenge was built using

• TypeScript
• Node JS
• Express JS
• MongoDB

SETTING UP THE PROJECT

To setup the project, please take the following steps.

• Clone the repo.

git clone https://github.com/johndiddles/todo-app-backend

• cd into the project

cd todo-app-backend

• install all dependencies

npm install

Before running the server, populate your process.env with the following variables

PORT=<YOUR PORT ID>
MONGO_URI=<YOUR MONGO_DB URI>
JWT_SECRET_KEY=<YOUR JWT SECRET KEY>

• run the server

npm run dev

TESTING THE ENDPOINTS

The endpoints can be tested using postman or any other api testing tool.

AVAILABLE ENDPOINTS

All endpoints available presently are listed below.

TASKS:

• POST /v1/tasks : Creates a new task.
• GET /v1/tasks : Retrieves all tasks.
  • query params include priority, status, tags, sharedWith, etc.
• GET /v1/tasks/:id : Retrieves a task by its ID.
• PUT /v1/tasks/:id : Updates an existing task by ID.
• DELETE /v1/tasks/:id : Deletes a task by ID.
• POST /v1/tasks/shares : Shares a task with another user.

USER:

• POST /v1/users/register : Creates a new task.
• GET /v1/users/login : Retrieves all tasks.

SAMPLE PAYLOADS

REGISTER USER:

{
  "email": "[email protected]",
  "username": "johnee",
  "password": "Password1"
}

LOGIN USER:

{
  "email": "[email protected]",
  "password": "Password1"
}

CREATE TASK:

{
  "title": "title one - Updated",
  "description": "description one",
  "dueDate": "2024-11-07T13:44:36.767Z",
  "status": "pending",
  "createdBy": "672c925bb365442d0acaffdd",
  "tags": ["random", "test"],
  "sharedWith": ["[email protected]", "[email protected]"],
  "assignedTo": "[email protected]",
  "createdAt": "2024-11-07T12:18:41.963Z",
  "updatedAt": "2024-11-07T12:18:41.963Z"
}

SHARE TASK:

{
  "id": "673f51baafcc26cfc8e19b1d", // id of the task to share
  "email": "[email protected]" // email address of the user to share with
}

RUNNING UNIT TESTS

Unit tests for this project is powered by Jest and Supertest while using mongoose and mongodb-memory-server to mock the mongodb database.

To run the unit tests,

• create a .env.test file and add your JWT_SECRET_KEY=<your jwt secret key>

  JWT_SECRET_KEY=<your_jwt_secret_key>

• run the command below

  npm run test