gauravshinde1816 / noteapp Goto Github PK

Express.js :

• Used minimalist node.js framework which comes with easy to setup HTTP server , router, middlware for creating backend routes and controllers.
• Provides this layer of abstraction on top of Node.js.

MongoDB :

• NoSQL Document database
• No specific reason to choose this database for current problem statement , could have been done using Postgres.
• MongoDB provide more flexible way to store Notes document and inject sharedWith users inside Note schema.

Docker and Docker compose:

• To containerize backend API
• I have hosted the image for my public docker hub repository.
• Will provide the compose file for the same.
• As of now there is only one backend image but more images can be added for frontend and database services etc

• MongoDB ORM/ODM
• Manages relationships between data, provides schema validation, and is used to translate between objects in code and the representation of those objects in MongoDB.

Clone the project git clone https://github.com/gauravshinde1816/noteApp.git

I have provided sample mongo DB atlas URL and other keys from default.json just make local setup simpler , feel free to replace that with your own keys.

Start backend

• cd noteApp/
• Install Dependancies
• npm install
• Start server
• npm start

Backend will start on http://localhost:5000.

Import the postman collection provided below and you will be able to run the APIs