<<<<<<< HEAD

Task Manager api

Tell a story
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• Contact
• Acknowledgements

About The Project

This is a task manager api built with NodeJs. It features authentication, full CRUD ability on tasks and email notifications on registration, account deletion and other crucial actions

Built With

• NodeJs
  • Mongoose
  • Express
• MongoDB
  • Database management
• Jest
  • Node testing with jest

Getting Started

1 fork the repo

2. clone to your local machine

3. npm install

4. npm start

Prerequisites

• npm packages

npm install

Installation

1. fork the repo

2. clone the Repo

3. install dependencies npm install

4. run dev server npm run dev

5. Test components npm test

App can be tested without cloning as it is deployed on the web
PRODUCTION EDNPOINT: "https://breellz-task-manager.herokuapp.com"

TO CREATE USERS Method: POST
ENDPOINT: "localhost:3000/users"
DATA-TYPE: JSON
body: { "name": "Bassit Owolabi", "email":"barseetbrn@gmail.com", "password": "123456" }

TO LOGIN USERS
Method: POST
ENDPOINT: "localhost:3000/users/login"
DATA-TYPE: JSON
body: { "email":"barseetbrn@gmail.com", "password": "123456" }

TO LOGOUT USERS
Method: POST
ENDPOINT: "localhost:3000/users/logout"
DATA-TYPE: JSON\

TO LOGOUT ALL SESSIONS
Method: POST
ENDPOINT: "localhost:3000/users/logoutAll"
DATA-TYPE: JSON

TO CREATE TASK
Method: POST
ENDPOINT: "localhost:3000/tasks"
DATA-TYPE: JSON
body: { "description": "store in production database ", "completed": false }

TO view user profile
Method: GET
ENDPOINT: "localhost:3000/users/me"
DATA-TYPE: JSON\

TO READ USER
Method: GET
ENDPOINT: "localhost:3000/users/id"
DATA-TYPE: JSON\

TO GET TASKS
Method: GET
ENDPOINT: "localhost:3000/tasks?sortby=createdAt:desc"
DATA-TYPE: JSON\

TO GET TASK
Method: GET
ENDPOINT: "localhost:3000/tasks/id"
DATA-TYPE: JSON\

TO UPDATE USER
Method: POST
ENDPOINT: "localhost:3000/users/me"
DATA-TYPE: JSON
body: { "name": "", "password": }

TO UPDATE TASK
Method: POST
ENDPOINT: "localhost:3000/tasks/id"
DATA-TYPE: JSON
body: { "completed": false }

TO DELETE USER
Method: DELETE
ENDPOINT: "localhost:3000/users/me"
DATA-TYPE: JSON

TO DELETE TASK
Method: DELETE
ENDPOINT: "localhost:3000/tasks/id"
DATA-TYPE: JSON\

TO UPLOAD AVATAR
Method: POST
ENDPOINT: "localhost:3000/users/me/avatar"
DATA-TYPE: form-data
KEY: upload
VALUE:image-file\

TO DELETE AVATAR
Method: DELETE
ENDPOINT: "localhost:3000/users/me/avatar"
DATA-TYPE: JSON\

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Twitter - @breellz

Facebook

stackoverflow

LinkedIn

Instagram

Project Link: https://github.com/breellz/task-manager-api

Acknowledgements

• Stackoverflow