Task Manager API

Task Manager API built using NodeJS & MongoDB

Table of Contents

1. Demo
2. Key Features
3. API Usage
4. Deployment
5. Build With
6. Installation
7. Known Bugs
8. Contributing
9. Contact

Deployed Version

Live demo (Feel free to visit) 👉 : Task Manager API

Key Features

• Get all tasks
• Create new task
• Get task using it's id
• update task using it's id
• delete task using it's id

API Usage

Check Task Manager API Documentation for more info.

Deployment

The API is deployed with git into Heroku. Below are the steps taken:

git init
git add -A
git commit -m "Commit message"

Built With

List of any major frameworks used to build the project.

• NodeJS - JS runtime environment
• ExpressJS - The NodeJS framework used
• MongoDB - NoSQL Database uses JSON-like documents with optional schemas
• Mongoose - Object Data Modeling (ODM) library for MongoDB and NodeJS
• Compression - NodeJS compression middleware
• Cors - NodeJS package for providing a Connect/Express middleware that can be used to enable CORS with various options
• Express Mongo Sanitize - Express 4.x middleware which sanitizes user-supplied data to prevent MongoDB Operator Injection.
• Dotenv - Loads environment variables from a . env file into process. env
• Rate Limiter - Basic IP rate-limiting middleware for Express
• Helmet - Secure Express apps by setting various HTTP headers
• Morgan - HTTP request logger middleware for NodeJS
• Winston - A logger for just about everything.
• XSS Clean - Middleware to sanitize user input
• Swagger UI Express - Allows you to serve auto-generated swagger-ui generated API docs from express.

Installation

You can fork the app or you can git-clone the app into your local machine. Once done that, please install all the dependencies by running

$ yarn install
set your env variables
$ yarn run build
$ yarn run start:prod

Known Bugs

Feel free to email me at mle.mahmoud.yasser@gmail.com if you run into any issues or have questions, ideas or concerns. Please enjoy and feel free to share your opinion, constructive criticism, or comments about my work. Thank you! 🙂

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 - @Mahmoud03203227

Email - mle.mahmoud.yasser@gmail.com

Facebook - MahmoudYasserMLE

Project: https://github.com/Braineanear/TaskManagerAPI