https://github.com/albertarakelyan/collaborative-markdown-editor-example

Collaborative Markdown Editor built on modern and simple web technologies with markdown editing libraries integrations. Can serve as a boilerplate for building your amazing app 😊.
https://github.com/albertarakelyan/collaborative-markdown-editor-example

codemirror collaborative-editing expressjs fullstack markdown-editor mongodb mongoose nodejs open-source react reactmarkdown socket socket-io typescript

Last synced: 28 days ago
JSON representation

Collaborative Markdown Editor built on modern and simple web technologies with markdown editing libraries integrations. Can serve as a boilerplate for building your amazing app 😊.

• Host: GitHub
• URL: https://github.com/albertarakelyan/collaborative-markdown-editor-example
• Owner: AlbertArakelyan
• License: mit
• Created: 2024-05-25T09:26:07.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-06T17:43:00.000Z (3 months ago)
• Last Synced: 2024-11-24T18:14:20.850Z (29 days ago)
• Topics: codemirror, collaborative-editing, expressjs, fullstack, markdown-editor, mongodb, mongoose, nodejs, open-source, react, reactmarkdown, socket, socket-io, typescript
• Language: TypeScript
• Homepage:
• Size: 909 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Collaborative Markdown Editor Example

![Screenshot](./client/public/screenshot.gif)



  

  

  

  

  

  





Collaborative Markdown Editor built on modern and simple web technologies with markdown editing libraries integrations, which allows a few users create and edit markdowns in real time through specific `documentId` sharable link and changes can be saved in database. Can serve as a boilerplate for building your amazing app 😊.



## 🔍 Table of Contents

- [🚀 Features](#-features)

- [📦 Installation](#-installation)

- [💡 Contributions](#-contributions)

- [📄 License](#-license)

## 🚀 Features

- Collaboriative `Mardkdown` editing in real time through sharable link

- Documents with their contents can be saved in **database**

- Documents can be resumed and accessed through their sharable url `/documents/:documentId`

## 📦 Installation

- Make sure you have `Docker` installed on your machine

- And run

```bash

docker compose up

```

_Note: On older versions of `Docker` through dash_

```bash

docker-compose up

```

## 💡 Contributions

Contributions are welcome! You can help make this example better in several ways:

- **Bug Fixes**: If you find any bugs, feel free to open an issue or submit a pull request to fix them.

- **Feature Requests**: Have an idea for a new feature or improvement? Share it by opening an issue.

- **Documentation**: Help improve the project's documentation to make it clearer and easier to understand.

- **Testing**: Write additional tests to ensure the reliability of the code.

- **Code Quality**: Review existing code and suggest improvements to make it more readable and maintainable.

Your contributions will make this example more user-friendly, reliable, and bug-free. Every contribution, big or small, is appreciated and will be acknowledged in the project's documentation. Read more in [CONTRIBUTION.md](./CONTRIBUTION.md).

## 📄 License

Licensed under the MIT License.