Repository files navigation

This API serves as a task management system, allowing users to create, retrieve, update, and delete tasks. Additionally, it provides user registration and authentication features, ensuring data security and user-specific task management.EndFragment

####Quick Links:

• Running the Project Locally
• API Documentation
  • Get All Tasks
  • Get Task
  • Add Task
  • Update Task
  • Delete Task
  • User Register
  • User SignIn

Follow these steps to set up and run the project on your local machine:

Before you proceed, ensure you have the following software installed on your system:

• Node.js
• MongoDB (or a connection string to a remote MongoDB database)
• Git (Optional, for cloning the repository)

To get a local copy of the repository, open your terminal and run:

git clone [REPO_URL]

Replace [REPO_URL] with the URL of your Git repository.

Once cloned, navigate to the project directory:

cd [PROJECT_DIRECTORY_NAME]

Replace [PROJECT_DIRECTORY_NAME] with the name of the directory where your project is located.

Now, install all the necessary project dependencies using npm:

npm install

To configure the environment, create a .env file in the project's root directory. Add the necessary configurations:

MONGO_URI=your_mongodb_connection_stringJWT_SECRET=your_jwt_secret_keyJWT_EXP=set_jwt_expiry

Make sure to replace the placeholders with your actual values.

####6. Start the Development ServerWith everything set up, start the development server:

npm start

Your server should now be running athttp://localhost:3000/ (or whatever port you specified in your .env).

This endpoint retrieves a list of all tasks associated with the authenticated user. It's typically used to populate a dashboard or task list in the user interface.

http://task-api.ap-south-1.elasticbeanstalk.com/tasks

Used to ensure that the user is authenticated and has the appropriate permissions to view tasks.

{"status":"Success","data": [    {"_id":"64fc5c8343d7271cae8c8604","title":"Protected Test Change","description":"To create an Task Api and add all specified task in the assignment","status":"todo","dueDate":"2023-09-19T00:00:00.000Z","user":"64fbd9f64c8d17f9e7b9b8ac","__v":0    },    {"_id":"64fc63db0c826ac69871ebea","title":"Protected Assignment 2","description":"To create an Task Api and add all specified task in the assignment","status":"todo","dueDate":"2023-09-19T00:00:00.000Z","user":"64fbd9f64c8d17f9e7b9b8ac","__v":0    },    {"_id":"64fc86bb0c826ac69871ebfa","title":"Protected Assignment 3","description":"To create an Task Api and add all specified task in the assignment","status":"todo","dueDate":"2023-09-19T00:00:00.000Z","user":"64fbd9f64c8d17f9e7b9b8ac","__v":0    }  ]}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Fetches the details of a specific task identified by its unique task ID. It's useful for viewing or editing details of a particular task.

http://task-api.ap-south-1.elasticbeanstalk.com/tasks/64fc5c8343d7271cae8c8603

Ensures that the authenticated user has permissions to view the specified task.

{"success":true,"data": {"_id":"64fc86bb0c826ac69871ebfa","title":"Protected Assignment 3","description":"To create an Task Api and add all specified task in the assignment","status":"todo","dueDate":"2023-09-19T00:00:00.000Z","user":"64fbd9f64c8d17f9e7b9b8ac","__v":0  }}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Allows the creation of a new task. Users can provide details such as title, description, status, and due date for the task they want to add.

http://task-api.ap-south-1.elasticbeanstalk.com/tasks

{"title":"Protected Assignment 2","description":"To create an Task Api and add all specified task in the assignment","status":"todo","dueDate":"2023-09-19"}

Ensures that the user is authenticated and can create tasks.

{"success":true,"data": {"title":"Protected Assignment 2","description":"To create an Task Api and add all specified task in the assignment","status":"todo","dueDate":"2023-09-19T00:00:00.000Z","user":"64fbd9f64c8d17f9e7b9b8ac","_id":"64fc86420c826ac69871ebf1","__v":0  }}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Modifies the details of an existing task identified by its unique task ID. Can be used to change any property of the task including its status.

http://task-api.ap-south-1.elasticbeanstalk.com/tasks/64fc5c8343d7271cae8c8604

{"title":"Protected Test Change","user":"64fc5c8343d7271cae8c8603"}

Ensures that the user is authenticated and has permissions to modify the task.

{"success":"true","data": {"_id":"64fc5c8343d7271cae8c8604","title":"Protected Test Change","description":"To create an Task Api and add all specified task in the assignment","status":"todo","dueDate":"2023-09-19T00:00:00.000Z","user":"64fbd9f64c8d17f9e7b9b8ac","__v":0  }}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Deletes a specific task from the system using its unique task ID. This ensures that the task will not be available or visible in subsequent requests.

http://task-api.ap-south-1.elasticbeanstalk.com/tasks/64fc63c00c826ac69871ebe2

Ensures that the user is authenticated and has permissions to delete the task.

{"success":"true","data": {"_id":"64fc86ad0c826ac69871ebf7","title":"Protected Assignment 2","description":"To create an Task Api and add all specified task in the assignment","status":"todo","dueDate":"2023-09-19T00:00:00.000Z","user":"64fbd9f64c8d17f9e7b9b8ac","__v":0  }}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Allows a new user to register to the system. The user provides essential details like username, email, and password. Upon successful registration, the user receives a token for authentication in future requests.

http://task-api.ap-south-1.elasticbeanstalk.com/users/register

{"username":"Sachita1","email":"test1@gmail.com","password":"test","cpassword":"test"}

{"success":"true","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY0ZmM4NzE1MGM4MjZhYzY5ODcxZWMwNSIsImlhdCI6MTY5NDI3MTI1MywiZXhwIjoxNzAyMDQ3MjUzfQ.Pgy_gm3p48nb4dVQY5x9Ck7obmEzp5RcGOzHu8N1ktw"}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Allows an existing user to sign in to the system using their email and password. Upon successful authentication, the user receives a token which must be used for subsequent requests that require authentication.

http://task-api.ap-south-1.elasticbeanstalk.com/users/signin

{"email":"test@gmail.com","password":"test"}

{"success":"true","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY0ZmM4NzE1MGM4MjZhYzY5ODcxZWMwNSIsImlhdCI6MTY5NDI3MTI2NiwiZXhwIjoxNzAyMDQ3MjY2fQ.FfJZn-zhyumIe9bmkYYnvj4qol4Yx_C8FDxOQEICIPM"}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃