ShanuDey/Task-Management-API

Task Management API

Installation

• Clone this repository
• Install node modules with npm i command
• Update environment variables, sample example.env is provied for reference
• Start api server with npm start command

Usage

• Postman -
• Base URL
  • Remote Host - https://tmapi.vercel.app/
  • Localhost - http://localhost:8000/
• Register user with first_name, last_name, email and password POST request body json parameters to /register route
  • Example - https://tmapi.vercel.app/register
  • [Optional] Create a test create email with one click
    • if you are using test email then you will receive a preview email from the response
    • click on the preview email link and verify email from there
• Login with email and password POST request body json paramaters to /login route
  • Example - https://tmapi.vercel.app/login
• Create a task as authenticated user with task, date and status POST request body json parameters to /task/create route
  • Example - https://tmapi.vercel.app/task/create
  • task is a String Object, date is a Date Object and status can only accept "Completed" or "Incomplete"
• View all created tasks as authenticated user with GET request to /task route
  • Example - https://tmapi.vercel.app/task
• Patch a task as authenticated user with any of these task, date and status PATCH request body json parameters to /task/:id route
  • Example - https://tmapi.vercel.app/task/:TASK_ID
• Delete a task as authenticated user with DELETE request to /task/:id route
  • Example - https://tmapi.vercel.app/task/:TASK_ID
• Logout with GET request to /logout route
  • Example - https://tmapi.vercel.app/logout

Feel free to put a start or raise an issue