mohittk / note-sharing-app

Note Sharing App

Note Sharing App is a web application built with Node.js, Express.js, and MongoDB, allowing users to share and manage notes collaboratively.

Introduction

Note Sharing App provides a platform for users to create, share, and collaborate on notes. Whether you're working on a project with a team or organizing personal thoughts, this app makes note-sharing seamless and efficient.

Frameworks, Database, and Tools

Frameworks

• Node.js: v14.0.0
  • Justification: Node.js provides a scalable and efficient environment for server-side development.
• Express.js: v4.17.1
  • Justification: Express is a fast, unopinionated, minimalist web framework for Node.js, making it ideal for building RESTful APIs.

Database

• MongoDB: v4.2.0
  • Justification: MongoDB is a NoSQL database that provides flexibility and scalability, making it suitable for storing and retrieving data in a Node.js application.
• Mongoose: v5.10.0
  • Justification: Mongoose is an ODM (Object Data Modeling) library for MongoDB and Node.js. It simplifies interactions with MongoDB, providing a straightforward way to model and query data.

Installation

Follow these steps to set up the Note Sharing App locally:

1. Clone the repository: git clone https://github.com/mohittk/note-sharing-app

2. Change to the project directory: cd note-sharing-app

3. Create a configuration file: Create a file named config.js in the root of the project. Refer to the attached config.js file provided in the Google Form submission.

4. Install dependencies: npm install

Usage

To run the Note Sharing App:

1. Run the application: npm start

Tests

Run tests for the Note Sharing App: npm test