Skip to content

Omkar-Jawalkar/real-time-text-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 Shareditor: Collaborate in Real-Time! 📝

🌟 Welcome to Shareditor

Shareditor is the ultimate real-time collaborative text editor that brings your team together, no matter where they are! 🌍✨

🔥 Key Features

  • 🔄 Real-time synchronization
  • 👥 Multi-user editing
  • 💬 In-document chat
  • 🎨 Rich text formatting
  • 📊 Version history
  • 🔒 End-to-end encryption

Example

Screen.Recording.2024-06-28.at.4.08.26.PM.mov

🚀 Getting Started

  1. Clone the repository:
git clone /~https://github.com/Omkar-Jawalkar/real-time-text-editor.git
  1. Install Dependencies:
cd frontend
npm install
cd backend
npm install

or

Docker

If you have docker installed then run this following command in root directory:

docker-compose up
  1. Start the server:
npm run dev  #frontend
npm run server  #backend
  1. Open your browser and navigate to http://localhost:5173/ 🌐
  2. Backend Starts on http://localhost:8080 🌐

🛠️ Tech Stack

  • Frontend: React ⚛️
  • Backend: Node.js 🟢
  • Real-time: Socket.io 🔌

🤝 Contributing

We love contributions! Please read our CONTRIBUTING.md file to get started. 🙌

📜 License

Shareditor is licensed under the MIT License. See the LICENSE file for details.

🐛 Found a bug?

If you've spotted a bug, please open an issue in our GitHub repository. We appreciate your help in making Shareditor better! 🕵️‍♀️

💡 Feature requests

Have an idea to make Shareditor even more awesome? We'd love to hear it! Open a feature request in our GitHub repository. 💭

🚀 Ready to revolutionize your collaborative writing?

Give Shareditor a star ⭐ and start editing together in real-time!

Happy collaborating! 🎈🎉