Task Manager REST API

Table of Contents

• Installation
• Routes
• Dependencies
• Future

---

Installation

This API is publicly available at https://task-manager-api-ahmad.herokuapp.com, you can test it through postman or implement it in a Web App.

Run it locally

git clone https://github.com/w28ahmad/Task-Manager-API.git && cd Task-Manager-API

You are going to need to create a config folder containing a dev.env file. This file will contain all the environment variables used in this REST API.

mkdir config & cd config & touch dev.env

In the dev.env file you are going to need the following enviroment variables:

1. PORT Can me anything you prefer, I usually go for 3000
2. SENDGRID_API_KEY This is for the automated emails welcoming the user when they create an account or saying goodbye when they delete their account. You can choose to ignore this environment variable everything should still work fine.
3. JWT_SECRET This could be ay set of characters (without spaces)
4. MONGODB_URL=mongodb://127.0.0.1:27017/task-manager-api You going to have to setup and connect to local mongoDB instance for this to work

Now you can run the REST API

npm run dev

Feel free to test any of the routes using Postman

---

Routes

• Create a User Account
• Login to your user accout
• Create a Task
• Update a Task
• Delete a Task
• Read a Task
• Update a User
• Delete a User
• Read a Task
• Read your User Details
• Logout

Create a User Account

Create an account to hold your tasks details. These user details are going to securely stored in a MongoDB Database.

POST: https://task-manager-api-ahmad.herokuapp.com/users

Example

{
	"name": "Wahab Ahmad",
	"email": "email@gmail.com",
	"password": "testing123"
}

Login to your Account

If you create an account you are automatically logged in. However, if you need to login you use the folloring route.

POST: https://task-manager-api-ahmad.herokuapp.com/users/login

Example

{
	"email": "dan@gmail.ca",
	"password": "testing123"
}

Create a Task

To add a task that you have to complete, use the following route:

POST: https://task-manager-api-ahmad.herokuapp.com/tasks

Example

{
	"discription": "Finish the Task Manager REST API",
	"completed" : false
	
}

Note: If you don't specify completed, it will be set to false by default

Update a Task

If you need to change/update a task you use the following route:

PATCH: https://task-manager-api-ahmad.herokuapp.com/tasks/{task_id}

Example

{
	"discription": "Finish the Task Manager REST API",
	"completed" : true
}

Note: Setting that task to true, you don't need to specify discription, I did it for the expample

Delete a Task

If you need to delete a task you can use the following route:

DELETE: https://task-manager-api-ahmad.herokuapp.com/tasks/{task_id}

Read a Task

If you want to read a task(s) use the following route:

GET: https://task-manager-api-ahmad.herokuapp.com/tasks

Here I have added parameters to filter, paginate and sort the results.

Pagination

GET: https://task-manager-api-ahmad.herokuapp.com/tasks/skip=3&limit=2

Here we are limiting the search result to tasks and skip sections the tasks

Sorting

GET: https://task-manager-api-ahmad.herokuapp.com/tasks?sortBy=createdAt:desc

This sorts the tasks in order of recency according to the timestamp

GET: https://task-manager-api-ahmad.herokuapp.com/tasks?sortBy=createdAt:asc

This sorts the tasks placing the the oldest tasks first

Filtering

GET: https://task-manager-api-ahmad.herokuapp.com/tasks?completed=false

This filters out the uncompleted tasks. Likewise setting completed to true will filter out the completed tasks. We can use all the methords together like so:

GET: https://task-manager-api-ahmad.herokuapp.com/tasks?skip=3&limit=2&completed=false&sortBy=createdAt:desc

Update a User

You are able to update the details of a user using:

PATCH: https://task-manager-api-ahmad.herokuapp.com/users/me

Example

{
	"name": "Wab",
	"email": "myemail@gmail.com",
	"password": "testing1234"
}

Delete a user

You are able to delete your user and his/her tasks using the following route:

Delete: https://task-manager-api-ahmad.herokuapp.com/users/me

Read your user profile

You are able to read your user profile information through the following route:

GET: https://task-manager-api-ahmad.herokuapp.com/users/me

Example Response

{
    "age": 0,
    "_id": "5cdf49eaa7135d00178bd58f",
    "name": "Wahab Ahmad",
    "email": "wab@gmail.com",
    "createdAt": "2019-05-17T23:55:22.608Z",
    "updatedAt": "2019-05-17T23:55:23.455Z",
    "__v": 1
}

Logout

Logout from your account using the following route:

POST: https://task-manager-api-ahmad.herokuapp.com/users/me

Upload a Profile Picture

I was interested in how to upload files so I created a route for uploading images:

POST: https://task-manager-api-ahmad.herokuapp.com/users/me/avatar

You can delete your avatar using the following route:

DELETE: https://task-manager-api-ahmad.herokuapp.com/users/me/avatar

The image is going to be resized and cropped, and then the binary will be stored in the Database.

---

Dependencies

1. Express
2. Multer
3. Sharp
4. Validator
5. Mongoose
6. Mongodb
7. jsonwebtoken
8. bcryptjs
9. @sendgrid/mail

---

Future

In the future, I hope to use React and Angular to create a front end that interacts with this REST API.