DigitalNoteBook Web Application

This project involves developing a backend application for a digital notebook platform, facilitating user authentication, note creation, retrieval, updating, and deletion. Additionally, users can share their notes with others and perform keyword-based searches to find relevant notes. The API aims to be secure, scalable, and efficient, ensuring a seamless user experience for managing and accessing notes.

Features

• User sign up and login with Email and password
• User can view the list of Notes
• User can manage Notes (add, update, delete. get)

Technologies Used

• Node.js
• Express.js
• MongoDB
• JSON Web Tokens (JWT) for authentication

Installations

To install and run the DigitalNoteBook application locally, follow these steps:

• Clone the repository:

  git clone https://github.com/bitleakash6/DigitalNoteBook/

• Navigate to the project directory:

  cd DigitalNoteBook

• Install dependencies using npm:

  npm install

• Start the application:

  npm start

Now, you should have the DigitalNoteBook application up and running on your local machine.

API Endpoints

Authentication Endpoints

Sign Up

• POST /api/auth/signup : Sign up a user

Login

• POST /api/auth/login: Login a user

Notes Endpoints

Display notes APIs

• GET /api/notes : get a list of all notes for the authenticated user.

• GET /api/notes/id : get a note by ID for the authenticated user.

Searach Notes

• GET /api/search?q=:query : search for notes based on keywords for the authenticated user.

Adding notes APIs

• POST /api/notes : create a new note for the authenticated user.

Update notes

• PUT /api/notes/id : update an existing note by ID for the authenticated user.

Delete Notes

• DELETE /api/notes/id : delete a note by ID for the authenticated user.

Share Notes

• POST /api/notes/:id/share : share a note with another user for the authenticated user.