mirrors/loro
1
0
Fork 0
mirror of https://github.com/loro-dev/loro.git synced 2025-02-02 11:06:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Reimagine state management with CRDTs. Make your app collaborative effortlessly.
1010 commits 47 branches 232 tags 38 MiB
Rust 96.2%
TypeScript 3.7%
Find a file
Leon zhao e01e98411c
feat: movable tree support (#120) 
* feat: tree state

* feat: tree value

* feat: tree handler

* fix: tree diff

* test: fuzz tree

* feat: tree snapshot

* fix: tree default value

* fix: test new node

* fix: tree diff

* fix: tree unresolved value

* fix: tree fuzz

* fix: tree fuzz move

* fix: sort by tree id

* fix: tree diff sorted by lamport

* fix: sort roots before tree converted to string

* fix: rebase main

* fix: tree fuzz

* fix: delete undo

* fix: tree to json children sorted

* fix: diff calculate

* fix: diff cycle move

* fix: tree old parent cache

* feat: cache

* fix: local op add tree cache

* fix: don't add same tree move to cache

* fix: need update cache

* feat: new cache

* bench: add checkout bench

* chore: clean

* fix: apply node uncheck

* perf: lamport bound

* fix: calc old parent

* feat: tree wasm

* fix: change tree diff

* fix: tree diff retreat

* fix: tree diff should not apply when add node

* feat: new tree loro value

* chore: typo

* fix: tree deep value

* fix: snapshot tree index -1

* fix: decode tree snapshot use state

* fix: release state lock when emit event

* fix: tree node meta container

* fix: need set map container when covert to local tree op

* fix: tree value add deleted

* fix: more then one op in a change

* fix: tree fuzz deleted equal

* fix: tree calc min lamport

* feat: tree encoding v2

* doc: movable tree

* fix: test tree meta

* test: remove import bytes check

* refactor: diff of text and map

* refactor: del span

* perf: tree state use deleted cache

* fix: some details

* fix: loro js tree create

* feat: add un exist tree node

* bench:  tree depth

* fix: check out should emit event

* refactor: event

* fix: fuzz err

* fix: pass all tests

* fix: fuzz err

* fix: list child cache err

* chore: rm debug code

* fix: encode enhanced err

* fix: encode enchanced

* fix: fix several richtext issue

* fix: richtext anchor err

* chore: rm debug code

* fix: richtext fuzz err

* feat: speedup text snapshot decode

* perf: optimize snapshot encoding

* perf: speed up decode & insert

* fix: fugue span merge err

* perf: speedup delete & id cursor map

* fix: fugue merge err

* chore: update utils

* fix: fix merge

* fix: return err apply op

* fix: fix merge

* fix: get map container as tree meta
2023-10-30 11:13:52 +08:00
.devcontainer chore: add dev container 2022-11-18 00:48:18 +08:00
.github/workflows Refactor: rm legacy code (#97) 2023-07-31 11:49:55 +08:00
.vscode Feat: Peritext-like rich text support (#123) 2023-10-29 14:02:13 +08:00
crates feat: movable tree support (#120) 2023-10-30 11:13:52 +08:00
docs docs: add comment for last&end 2023-02-09 16:30:22 +08:00
loro-js feat: movable tree support (#120) 2023-10-30 11:13:52 +08:00
scripts chore: dev container config 2022-11-18 00:31:11 +08:00
supply-chain chore: update crdt-list dep 2022-10-26 23:35:21 +08:00
.editorconfig feat: rle 2022-07-13 00:47:41 +08:00
.gitignore Feat: Peritext-like rich text support (#123) 2023-10-29 14:02:13 +08:00
Cargo.lock chore: rm needless package 2023-10-29 22:13:59 +08:00
Cargo.toml Perf: speed up utf16 and wasm (#90) 2023-04-03 09:29:25 +08:00
deno.jsonc Feat: Peritext-like rich text support (#123) 2023-10-29 14:02:13 +08:00
deno.lock bench(wasm): wasm bench 2022-12-09 10:46:36 +08:00
deny.toml chore: add cargo deny config 2022-07-17 16:33:16 +08:00
package.json Perf: speed up utf16 and wasm (#90) 2023-04-03 09:29:25 +08:00
pnpm-lock.yaml feat: event & wasm 2023-07-29 02:03:51 +08:00
pnpm-workspace.yaml Perf: speed up utf16 and wasm (#90) 2023-04-03 09:29:25 +08:00
README.md docs: update readme 2023-10-29 21:37:24 +08:00
rust-toolchain chore: use stable rust as GAT become stable 2022-11-06 23:18:15 +08:00

README.md

Loro
Sync state easily with CRDTs

Notice: The current API and encoding schema of Loro are experimental and subject to change. It is not recommended for use in production environments at this time.

Loro is a CRDTs(Conflict-free Replicated Data Types) library that allows you to persist and sync state easily. It is designed for building local-first software.

What are CRDTs? Conflict-free Replicated Data Types (CRDTs) are data structures that enable automatic conflict resolution. It allows users to make changes together, in real-time or asynchronously, without conflicting and without relying on a central server.

Features

Supported CRDT Algorithms

  • Basic Data Structures: Includes support for List for ordered collections, LWW(Last Write Win) Map for key-value pairs, Tree for hierarchical data, and Text for rich text manipulation, enabling a wide variety of applications.
  • Text Editing with Fugue: Loro integrate Fugue, a sophisticated CRDT algorithm designed to minimize conflicts in text editing, which is particularly useful for collaborative document editing.
  • Rich Text with Peritext-like CRDT: Drawing inspiration from Peritext, Loro manages rich text CRDTs that excel at merging concurrent rich text style edits, maintaining the original intent of each user's input as much as possible. Details on this will be explored further in an upcoming blog post.
  • Hierarchical Data with Moveable Tree: For applications requiring directory-like data manipulation, Loro utilizes the algorithm from A Highly-Available Move Operation for Replicated Trees, which simplifies the process of moving and reorganizing hierarchical data structures.

Advanced Editing Features

  • Preserve Editing History
    • With Loro, you can track changes effortlessly as it records the editing history with low overhead.
    • This feature is essential for audit trails, undo/redo functionality, and understanding the evolution of your data over time.
  • Time Travel Through History
    • It allows users to compare and merge manually when needed, although CRDTs typically resolve conflicts well.

Other Features

  • High Performance
  • Decentralized Synchronization: Loro allows your app's state can be synced via p2p connections.
  • Automatic Merging: Say goodbye to merge conflicts. Loro guarantees eventual consistency, automating the merging of concurrent changes.
  • Local Availability: Data is persistently available on users' devices, ensuring offline functionality and real-time responsiveness.
  • Scalability: Effortlessly scale your application horizontally thanks to the inherently distributed nature of CRDTs.
  • Delta Updates: Loro has out-of-the-box support for delta updates.

Credits

Loro draws inspiration from the innovative work of the following projects and individuals:

  • Ink & Switch: The principles of Local-first Software have greatly influenced this project. The Peritext project has also shaped our approach to rich text CRDTs.
  • Diamond-types: The ingenious OT-like merging algorithm from @josephg has been adapted to reduce the computation and space usage of CRDTs.
  • Automerge: Their use of columnar encoding for CRDTs has informed our strategies for efficient data encoding.
  • Yjs: We have incorporated a similar algorithm for the effective merging of collaborative editing operations, thanks to their pioneering contributions.
  • Matthew Weidner: His work on the Fugue algorithm has been invaluable, enhancing our text editing capabilities.