Awesome
<p align="center"> <a href="https://loro.dev"> <picture> <img src="./docs/Loro.svg" width="200"/> </picture> </a> </p> <h1 align="center"> <a href="https://loro.dev" alt="loro-site">Loro</a> </h1> <p align="center"> <b>Make your JSON data collaborative and version-controlled π¦</b> </p> <p align="center"> <a href="https://trendshift.io/repositories/4964" target="_blank"><img src="https://trendshift.io/api/badge/repositories/4964" alt="loro-dev%2Floro | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> </p> <p align="center"> <a href="https://loro.dev/docs"> <b>Documentation</b> </a> | <a href="https://loro.dev/docs/tutorial/get_started"> <b>Getting Started</b> </a> | <a href="https://docs.rs/loro"> <b>Rust Doc</b> </a> </p> <p align="center"> <a aria-label="X" href="https://x.com/loro_dev" target="_blank"> <img alt="" src="https://img.shields.io/badge/Twitter-black?style=for-the-badge&logo=Twitter"> </a> <a aria-label="Discord-Link" href="https://discord.gg/tUsBSVfqzf" target="_blank"> <img alt="" src="https://img.shields.io/badge/Discord-black?style=for-the-badge&logo=discord"> </a> <a aria-label="Gurubase" href="https://gurubase.io/g/loro" target="_blank"> <img alt="" src="https://img.shields.io/badge/Ask%20Loro%20Guru-000000?style=for-the-badge"> </a> </p>https://github.com/loro-dev/loro/assets/18425020/fe246c47-a120-44b3-91d4-1e7232a5b4ac
<h4 align="center"> β¨ Loro 1.0 is out! Read the <a href="https://loro.dev/blog/v1.0">announcement</a>. </h4>Loro is a CRDTs(Conflict-free Replicated Data Types) library that makes building local-first and collaborative apps easier. You can now use it in Rust, JS (via WASM), and Swift.
Features
Features Provided by CRDTs
- P2P Synchronization
- Automatic Merging
- Local Availability
- Scalability
- Delta Updates
Supported CRDT Algorithms
- π Text Editing with Fugue
- π Peritext-like Rich Text CRDT
- π² Moveable Tree
- π Moveable List
- πΊοΈ Last-Write-Wins Map
Advanced Features in Loro
- π Fast Document Loading
- β±οΈ Fast Time Travel Through History
- ποΈ Version Control with Real-Time Collaboration
- π¦ Shallow Snapshot that Works like Git Shallow Clone
https://github.com/user-attachments/assets/68e0017a-4987-4f71-b2cf-4ed28a210987
In this example, we demonstrate importing an entire Loro codebase into a Loro-powered version controller, preserving the complete Git DAG history while enabling fast version switching.
Example
import { expect, test } from 'vitest';
import { LoroDoc, LoroList } from 'loro-crdt';
test('sync example', () => {
// Sync two docs with two rounds of exchanges
// Initialize document A
const docA = new LoroDoc();
const listA: LoroList = docA.getList('list');
listA.insert(0, 'A');
listA.insert(1, 'B');
listA.insert(2, 'C');
// Export all updates from docA
const bytes: Uint8Array = docA.export({ mode: 'update' });
// Simulate sending `bytes` across the network to another peer, B
const docB = new LoroDoc();
// Peer B imports the updates from A
docB.import(bytes);
// B's state matches A's state
expect(docB.toJSON()).toStrictEqual({
list: ['A', 'B', 'C'],
});
// Get the current version of docB
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 sync point
const bytesB: Uint8Array = docB.export({ mode: 'update', from: version });
// Simulate sending `bytesB` back across the network to A
// A imports the updates from B
docA.import(bytesB);
// A has the same state as B
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 Event Graph Walker (Eg-walker) 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 work.
- 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.