Versioned Notes is a robust note-taking application designed to address two key objectives in the field of documentation:
-
Versioning System:
- Implements Myers' diff algorithm for efficient versioning.
- Saves incremental changes with a version number and timestamp for easy identification and retrieval of previous versions.
- Enables users to review and revert to older versions of their notes.
-
Collaborative Editing with Suggestions:
- Allows users to select a section of the note and suggest changes.
- Suggested changes are reflected as annotations, visible to the note owner.
- Facilitates collaborative editing, with the note owner having the final say on accepting or rejecting suggestions.
-
NodeTS: The project is built using TypeScript on the Node.js runtime for a scalable and maintainable codebase.
-
Express: Utilizes the Express.js framework to streamline the development of the server-side application, ensuring robustness and efficiency.
-
Mongoose: Implements Mongoose, an elegant MongoDB object modeling tool designed to work in an asynchronous environment. Mongoose simplifies interactions with the MongoDB database, providing a schema-based solution for data validation and structuring.
To run this project locally, follow these steps:
- Clone the Repository:
git clone https://github.com/singhayushh/versioned-notes.git- Install Dependencies
cd versioned-notes
npm install-
Configure Env Use the .env.example file to create a .env with necessary configs.
-
Run the Application
npm start- Access the API Use the postman collection shared for testing out he APIs.
Feel free to contribute by opening issues, suggesting features, or submitting pull requests. Follow the standard coding guidelines and documentation conventions.
This project is licensed under the MIT License. See the LICENSE file for details.