https://github.com/danfuzz/bayou
Collaborative document editing, with Quill-based front end
https://github.com/danfuzz/bayou
document editor nodejs operational-transformation quill
Last synced: 12 days ago
JSON representation
Collaborative document editing, with Quill-based front end
- Host: GitHub
- URL: https://github.com/danfuzz/bayou
- Owner: danfuzz
- License: other
- Created: 2016-09-28T23:36:15.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2022-06-22T16:27:39.000Z (almost 3 years ago)
- Last Synced: 2025-05-01T10:40:38.956Z (18 days ago)
- Topics: document, editor, nodejs, operational-transformation, quill
- Language: JavaScript
- Homepage:
- Size: 5.9 MB
- Stars: 21
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Bayou
=====
Bayou is a collaborative document editor, which uses [Quill](https://quilljs.com/)
on the front end. It includes synchronization of document state across multiple
clients. **It is a work in progress.**
### Theory of operation
See the [client state diagram](https://raw.githubusercontent.com/danfuzz/bayou-docs/master/client-states.png)
for an overview of how the system operates from the client's perspective. This
is a straightforward (fairly unsurprising) operational-transform implementation.
See the [document structure diagram](https://raw.githubusercontent.com/danfuzz/bayou-docs/master/document-structure.png)
for an outline of how data is represented and stored.
### Other information
* [Documentation directory](doc/)
* Particularly useful: [Development Guide](doc/development.md)
* [Authors](AUTHORS.md) (and acknowledgments)
* [Contributing](CONTRIBUTING.md)
* [License](LICENSE.md)
- - - - - - - - - -
```
Copyright 2016-2019 the Bayou Authors (Dan Bornstein et alia).
Licensed AS IS and WITHOUT WARRANTY under the Apache License,
Version 2.0. Details:
```