The Notes API is a Node.js application that provides CRUD operations for managing notes. Users can create, read, update, and delete their notes, as well as share notes with other users.
- User authentication using JSON Web Tokens (JWT)
- CRUD operations for managing notes
- Share notes with other users
- Search functionality based on keywords
- Node.js
- Express.js
- MongoDB
- Mongoose ODM (Object Data Modeling)
- JSON Web Tokens (JWT) for authentication
- Rate limiting and request throttling for handling high traffic
-
Clone the repository:
git clone https://github.com/Alchemist1411/Asssment-Speer-Backend.git cd <project-directory>
-
Install Dependencies:
npm install
-
Required enviornment:
Has been setup already with dummy JWT_SECRET_KEY and User/Notes Database for easily testing the endpoints.
-
Run the Application:
To run app using nodemon on your machine
npm run dev
-
For API Testing:
Use either Postman or Thunderclient to test the API endpoints While using /api/notes/ endpoints pass the Authorization token, which you got during user login.