https://github.com/vishaljadhav207/document-editor

Real time document editor it uses WebSocket.
https://github.com/vishaljadhav207/document-editor

Last synced: 8 days ago
JSON representation

Real time document editor it uses WebSocket.

• Host: GitHub
• URL: https://github.com/vishaljadhav207/document-editor
• Owner: vishaljadhav207
• License: mit
• Created: 2024-01-23T14:43:50.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-01-24T14:32:25.000Z (11 months ago)
• Last Synced: 2024-01-24T18:28:03.934Z (11 months ago)
• Language: JavaScript
• Size: 3.29 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Real-Time Document Editor

### This is a real-time document editor that allows multiple users to collaboratively edit a shared document. 

### The application uses WebSocket for real-time communication and MongoDB for persistent storage.

### Demo Video

https://github.com/vishaljadhav207/Document-Editor/assets/95490543/5661e0c8-f10a-402d-b978-e44ab3382231

### Technologies Used

1. Frontend:

  - React

  - Quill (Text editor for rich text editing)

  - Socket.io-client (WebSocket client for real-time communication)

2. Backend:

  - Node.js

  - Express

  - Socket.io (WebSocket server for real-time communication)

  - MongoDB (Database for storing document data)

### Setup Instructions

  - Prerequisites

  - Node.js installed on your machine

  - MongoDB server running on mongodb://127.0.0.1:27017

### Inastallation

  - Clone repository

  - git clone https://github.com/vishaljadhav207/Document-Editor.git

  - cd client

  - npm install

  - cd ../server

  - npm install

  - cd server

  - npm start

  - cd client

  - npm start

### Usage

1. Open your web browser and go to http://localhost:3000.

2. Collaborate in real-time with others by sharing the document ID.

3. Make changes to the document and observe real-time updates.