Skip to content

arpitsinghania8/task-management-system

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Task Management System API

The Task Management System API is a RESTful API built using Node.js with Express. It allows users to create, read, update, and delete tasks. The API uses token-based authentication and authorization for secure access to endpoints.

Prerequisites

Before setting up the API, make sure you have the following installed on your system:

Setup Instructions

  1. Clone the repository or download the source code:
git clone https://github.com/your-username/task-management-api.git
  1. Change directory to the project folder:
cd task-management-api
  1. Install the dependencies:
npm install

Running the API

  1. Start your MongoDB server. If you're using the default configuration, simply run:
mongod
  1. Start the API server:
npm start
  1. The API will start running at http://localhost:3000.

API Documentation (Swagger)

You can access the API documentation using Swagger UI. Open your web browser and visit:

http://localhost:3000/api-docs

Running Unit Tests

To run the unit tests, use the following command:

npm test

API Endpoints

The API provides the following endpoints:

  1. POST /users/register: User registration (Create a new user).

  2. POST /users/login: User login (Get JWT token).

  3. POST /tasks: Create a new task (Authentication required).

  4. GET /tasks: Retrieve all tasks (Authentication required).

  5. GET /tasks/:id: Retrieve a specific task by ID (Authentication required).

  6. PATCH /tasks/:id: Update a task (Authentication required).

  7. DELETE /tasks/:id: Delete a task (Authentication required).

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published