Skip to content

Rtulpe/Collabz

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Collabz Editor

Collabz Editor is a robust, LAN-ready real-time collaborative text editor supporting seamless multi-user editing, automatic failover, and multi-server leader election. It is designed for reliability and easy deployment across multiple machines on your local network.

Overview

  • Multi-server architecture: Python and Node.js servers can run on different machines, with automatic leader election and failover.
  • LAN-ready React client: Connects to the current main server, auto-reconnects on failover, and provides a modern collaborative UI.
  • No shared files: All state and election info is synced over the network.
  • Config-driven: All servers and clients are configured via JSON files for easy deployment.

Requirements

  • Node.js (see .nvmrc for recommended version) for the client and JS server
  • Python 3.8+ for the Python server
  • LAN connectivity between all devices

How to Run & Configure

  1. Configure your servers and client
    • Each server (JS or Python) must have a unique id, its own port, and a list of all peer servers in its server_config.json.
    • The client uses client_config.json to list all server addresses and its own address.
  2. Start the servers
  3. Start the client

More Information


Collabz Editor is open source and MIT licensed. Contributions and improvements are welcome!


Original inspiration and base code: This project is an improved and extended fork of Haddajii's Real-time-collaborative-text-editor, originally released under the MIT License.

About

Collaborative Editor

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 46.0%
  • TeX 21.1%
  • Python 17.3%
  • CSS 7.7%
  • HTML 4.4%
  • Nix 3.5%