A secure and scalable RESTful API for managing and sharing notes. This project is built using Node.js, Express.js, MongoDB, and Mongoose.

• Project Overview
• API Endpoints
• Setup and Installation
• Testing

The project is implemented using Node.js and Express.js for the backend, MongoDB as the database, and Mongoose as the ODM. It includes user authentication using JsonWebToken , rate limiting, request throttling, and powerful search functionality.

• POST /api/auth/signup: Create a new user account.
• POST /api/auth/login: Log in to an existing user account and receive an access token.

• 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.
• POST /api/notes: Create a new note for the authenticated user.
• PUT /api/notes/:id: Update an existing note by ID for the authenticated user.
• DELETE /api/notes/:id: Delete a note by ID for the authenticated user.
• POST /api/notes/:id/share: Share a note with another user for the authenticated user.
• GET /api/search?q=:query: Search for notes based on keywords for the authenticated user.

• Choice of Framework/DB/3rd Party Tools
  • Framework: Express.js was chosen for its simplicity and flexibility.
  • Database: MongoDB with Mongoose for a NoSQL solution that scales well.
  • Authentication: JWT (JSON Web Tokens) for secure authentication.
  • Rate Limiting/Request Throttling: Implemented using express-rate-limit middleware.
  • Search Functionality: MongoDB text indexing for efficient keyword-based search.

1. Clone the repository:

   git clone https://github.com/arpit330/NotesAPI
   

2. Run npm install

3. Make .env file with PORT , URI , JWT_SECRET_KEY variables

4. Run npm run dev

1. Clone the repository:

2. Run docker build -t notes-app .

3. RUN docker container run -d notes-app