Overview
Qwikcollab is a collaborative code editor that allows multiple people on different machines to work together on a single document on a web page. It uses operational transformation for managing document versions and CodeMirror as the code editor package. Changes are transferred using websockets.
Features
- Collaborative editing: Allows multiple users to edit a document simultaneously.
- Operational transformation: Manages document versions and merges changes from different clients.
- CodeMirror integration: Provides an extensible code editor for enhanced editing experience.
- Real-time communication: Uses websockets to transfer changes instantly between users.
Installation
To install Qwikcollab, follow these steps:
- Clone both the repositories.
- Install NPM packages on both repositories.
- Copy environment variables.
- Ensure you have a running PostgreSQL database and update the DATABASE_URL accordingly in server .env.
- Run prisma migration.
- Start the application.
Summary
Qwikcollab is a collaborative code editor that allows multiple users to work together on a single document. It uses operational transformation to manage document versions and CodeMirror as the code editor package. With real-time communication through websockets, Qwikcollab provides a seamless and efficient collaboration experience. Contributions to the project are welcomed, and the repository aims to be a helpful resource for learning about collaborative editing.