Reimagine state management with CRDTs. Make your app collaborative effortlessly.
Find a file
Zixuan Chen afbcee99b3
perf: avoid memory leak when forking repeatedly (#500)
* perf: avoid memory leak when forking repeatedly

* fix: use the safest way to fork
2024-10-08 17:24:08 +08:00
.changeset chore: version packages (#451) 2024-09-07 19:44:32 +08:00
.devcontainer chore: add dev container 2022-11-18 00:48:18 +08:00
.github/workflows Perf: optimize speed of large maps (#496) 2024-10-05 14:35:56 +08:00
.vscode Fix warnings (#484) 2024-09-29 21:15:19 +08:00
crates perf: avoid memory leak when forking repeatedly (#500) 2024-10-08 17:24:08 +08:00
docs feat: Stable JSON representation for history (#368) 2024-06-07 13:18:30 +08:00
examples/loro-quill Fix using loro in cloudflare worker (#441) 2024-09-05 13:10:27 +08:00
loro-js Refactor rename trimmed snapshot to shallow snapshot (#499) 2024-10-08 13:15:14 +08:00
scripts chore: bump rust crates version 2024-08-29 23:02:03 +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 chore: add coverage report cli (#311) 2024-04-02 22:27:45 +08:00
Cargo.lock feat: add FFI for Loro (#420) 2024-09-29 07:41:59 +08:00
Cargo.toml feat: add FFI for Loro (#420) 2024-09-29 07:41:59 +08:00
cliff.toml chore: bump loro-crdt 2024-04-05 02:25:25 +08:00
CONTRIBUTING.md fix: upgrade wasm-bindgen to fix str free err (#353) 2024-05-09 15:22:34 +08:00
deno.lock feat: stabilizing encoding (#219) 2024-01-02 17:03:24 +08:00
deny.toml chore: add cargo deny config 2022-07-17 16:33:16 +08:00
LICENSE Create LICENSE 2023-11-12 23:11:25 +08:00
package.json Perf: optimize speed of large maps (#496) 2024-10-05 14:35:56 +08:00
pnpm-lock.yaml Refactor rename trimmed snapshot to shallow snapshot (#499) 2024-10-08 13:15:14 +08:00
pnpm-workspace.yaml Add richtext example using Quill (#145) 2023-11-03 16:59:27 +08:00
README.md docs: rm experimental warning 2024-07-14 14:00:00 +08:00
rust-toolchain chore: use stable rust as GAT become stable 2022-11-06 23:18:15 +08:00
test.sh chore: add test tools (#410) 2024-07-25 19:14:02 +08:00

Loro

Reimagine state management with CRDTs 🦜
Make your app state synchronized and collaborative effortlessly.

loro-dev%2Floro | Trendshift

Documentation | Getting Started | Rust Doc

https://github.com/loro-dev/loro/assets/18425020/fe246c47-a120-44b3-91d4-1e7232a5b4ac

Loro is a CRDTs(Conflict-free Replicated Data Types) library that makes building local-first apps easier. It is currently available for JavaScript (via WASM) and Rust developers.

Explore our vision in our blog: Reimagine State Management with CRDTs.

Features

Basic Features Provided by CRDTs

  • P2P Synchronization
  • Automatic Merging
  • Local Availability
  • Scalability
  • Delta Updates

Supported CRDT Algorithms

Advanced Features in Loro

https://github.com/loro-dev/loro/assets/18425020/ec2d20a3-3d8c-4483-a601-b200243c9792

Example

Open in StackBlitz

import { expect, test } from 'vitest';
import { Loro, LoroList } from 'loro-crdt';

/**
 * Demonstrates synchronization of two documents with two rounds of exchanges.
 */
// Initialize document A
const docA = new Loro();
const listA: LoroList = docA.getList('list');
listA.insert(0, 'A');
listA.insert(1, 'B');
listA.insert(2, 'C');

// Export the state of document A as a byte array
const bytes: Uint8Array = docA.exportFrom();

// Simulate sending `bytes` across the network to another peer, B
const docB = new Loro();
// Peer B imports the updates from A
docB.import(bytes);

// Verify that B's state matches A's state
expect(docB.toJSON()).toStrictEqual({
  list: ['A', 'B', 'C'],
});

// Get the current operation log version of document B
const version = docB.oplogVersion();

// Simulate editing at B: delete item 'B'
const listB: LoroList = docB.getList('list');
listB.delete(1, 1);

// Export the updates from B since the last synchronization point
const bytesB: Uint8Array = docB.exportFrom(version);

// Simulate sending `bytesB` back across the network to A
// A imports the updates from B
docA.import(bytesB);

// Verify that the list at A now matches the list at B after merging
expect(docA.toJSON()).toStrictEqual({
  list: ['A', 'C'],
});

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 Replayable Event Graph (REG) 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 effectively merging collaborative editing operations, thanks to their pioneering works.
  • Matthew Weidner: His work on the Fugue algorithm has been invaluable, enhancing our text editing capabilities.
  • Martin Kleppmann: His work on CRDTs has significantly influenced our comprehension of the field.