https://github.com/tomaszrewak/timewriter

An online collaborative text editor based on event sourcing architecture.
https://github.com/tomaszrewak/timewriter

collaborative event-sourcing react text-editor website websockets

Last synced: about 2 months ago
JSON representation

An online collaborative text editor based on event sourcing architecture.

• Host: GitHub
• URL: https://github.com/tomaszrewak/timewriter
• Owner: TomaszRewak
• License: mit
• Created: 2018-11-20T19:59:11.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-22T12:17:00.000Z (over 6 years ago)
• Last Synced: 2025-04-21T13:39:05.351Z (6 months ago)
• Topics: collaborative, event-sourcing, react, text-editor, website, websockets
• Language: JavaScript
• Homepage: https://text-sourcing.tomasz-rewak.com/
• Size: 1.55 MB
• Stars: 46
• Watchers: 7
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Text sourcing

An online collaborative text editor based on event sourcing.

Working example can be found here: https://text-sourcing.tomasz-rewak.com/

A longer project description can be found here: https://blog.tomasz-rewak.com/text-sourcing/

Everything here is written from a scratch: including the text editor as well as the event sourcing logic on the server and the client sides.

# About the project

This text editor enables multiple people to edit the same text file at the same time. 

All users should be even able to edit the same line without any input drops.  

This app doesn't send the entire content of the file between users after each change is made, but rather just basic events.

Base on those events and the initial state of the document each client should be able to recreate the current state of the document.

Event management is not only limited to simple state transformations. Event history is also used for undo/redo operations.

The order of events is synchronized based on the server's internal clock so that the impact of communication delay can be neutralized.

# Technology

This project is created using javascript, socket.io (for the clinet-server communication) and react (a frontend framework).

# Disclaimer

It's just a demo that I've created as a pet project. 

But if you've found any bugs, please, let me know.