Pranshu820 / SECUREU-Note-Taker

Backend Assignment of SECUREU

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SECUREU-Note-Taker

Introduction

Crafted with Node.js, Express, and MongoDB, our sophisticated backend note management system elevates your productivity. Seamlessly integrating user authentication and note management functionalities, it offers a streamlined experience for organizing your thoughts.

Setup Instructions

  1. Clone the repository.
git clone https://github.com/Pranshu820/SECUREU-Note-Taker
  1. Ensure Node.js is installed on your machine.

  2. Install dependencies

npm install
  1. Set up the MongoDB database and obtain the connection URI.

  2. Create a .env file in the root directory and add the following environment variables:

PORT=3000
MONGODB_URI=your_mongodb_connection_uri
JWT_SECRET=your_secret_key
CORS_ORIGIN=http://localhost:3000

Running the Application

To start the application, run:

npm run dev

Testing

Postman or any preferred API testing tool facilitates thorough examination of the application's functionalities. Here's a breakdown of available endpoints:

  1. Register User - POST "/api/auth/register"
  2. Login User - POST "/api/auth/login"
  3. Get User - GET "/api/auth/"
  4. Create Note - POST "/api/notes/"
  5. Get Notes - GET "/api/notes/"
  6. Update Note - PUT "/api/notes/:id"
  7. Delete Note - DELETE "/api/notes/:id"

License

MIT

Contributing

We warmly welcome contributions from everyone. If you have suggestions for improvements or new features, please feel free to open an issue or make a pull request. Your input is invaluable in enhancing the functionality and user experience of this project.

Together, let's create something exceptional!

About

Backend Assignment of SECUREU


Languages

Language:JavaScript 100.0%