To do list API using nodejs

A complete REST API for your to-do app including login, register and crud operations written using nodejs

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Endpoints
• Roadmap
• Contributing
• License

About The Project

This project is based on Nodejs. This is a complete ready to go api for a to do list app.

Built With

• nodejs
• body-parser
• cookie-parser
• cors
• dotenv
• express
• jsonwebtoken
• mongoose

Getting Started

Prerequisites

Install node packege manager using

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/githmin/todolist-api-nodejs.git

2. cd into the directory

cd todolist-api-nodejs

3. run below command to install dependencies

npm install

4. set .env variables

   dbUrl = your mongodb url here

   port = your desired port here

   secret = jwt encoding secret here

Endpoints

Register ==> (Post request) ==> api/v1/login/register

Login ==> (Post request) ==> /api/v1/login

To add | delete | update | delete, make relevent requests to this path ==> /api/v1/

JsonWebToken is used for authentication

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.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch
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

License

Distributed under the MIT License.