https://github.com/mokshit06/task-manager-api

Node.js API with MongoDB database for managing tasks
https://github.com/mokshit06/task-manager-api

Last synced: 7 days ago
JSON representation

Node.js API with MongoDB database for managing tasks

• Host: GitHub
• URL: https://github.com/mokshit06/task-manager-api
• Owner: Mokshit06
• Created: 2020-06-09T17:18:53.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-22T16:55:24.000Z (about 2 years ago)
• Last Synced: 2024-10-31T20:03:03.246Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 385 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Task Manager API

A **Node.js** CRUD API with a **MongoDB** Database. You can check the API [here](https://tasks-management-api.herokuapp.com/)

- Users can create their account

- Can generate JWT tokens

- Users can upload their avatars

- Users can add tasks to their account

## Requirements

- NodeJS

- MongoDB

- SendGrid API Keys

## How to use?

- Clone the repository.

- Navigate to the repository and run `npm install`.

- Add your **SendGrid API keys**, **Database route** and **JWT Secret** to the `config/dev.env` file.

- Type `npm run dev` to start the dev server.

## Endpoints

- `/users` to create account

- `/users/login` to login

- `/users/logout` to logout of the current device

- `/users/logoutAll` to logout of all devices

- `/users/me` to read authenticated profile

- `/users/me` to read, update and delete authenticated user

- `/users/me/avatar` to upload avatar

- `/tasks` to read all the tasks

  - `?completed=` to get tasks based on whether they are completed or not

  - `?limit=__&skip=__` for pagination

  - `?sort:` to sort tasks based on their date

- `/tasks/` to get, update and delete a task by its ID

## License

> MIT