![](\"./docs/Loro.svg\")
\n \n \n \n
\n Reimagine state management with CRDTs π¦
\n Make your app state synchronized and collaborative effortlessly.\n
\n \n
\n \n Documentation\n \n |\n \n Getting Started\n \n |\n \n Rust Doc\n \n
\n\n\n\nhttps://github.com/loro-dev/loro/assets/18425020/fe246c47-a120-44b3-91d4-1e7232a5b4ac\n\nLoro is a [CRDTs(Conflict-free Replicated Data Types)](https://crdt.tech/) library that makes building [local-first apps][local-first] easier. It is currently available for JavaScript (via WASM) and Rust developers. \n\nExplore our vision in our blog: [**β¨ Reimagine State Management with CRDTs**](https://loro.dev/blog/loro-now-open-source).\n\n# Features\n\n**Basic Features Provided by CRDTs**\n\n- P2P Synchronization\n- Automatic Merging\n- Local Availability\n- Scalability\n- Delta Updates\n\n**Supported CRDT Algorithms**\n\n- π Text Editing with [Fugue]\n- π [Peritext-like Rich Text CRDT](https://loro.dev/blog/loro-richtext)\n- π² [Moveable Tree](https://loro.dev/docs/tutorial/tree)\n- π [Moveable List](https://loro.dev/docs/tutorial/list)\n- πΊοΈ [Last-Write-Wins Map](https://loro.dev/docs/tutorial/map)\n- π [Replayable Event Graph](https://loro.dev/docs/advanced/replayable_event_graph)\n\n**Advanced Features in Loro**\n\n- π Preserve Editing History in a [Replayable Event Graph](https://loro.dev/docs/advanced/replayable_event_graph)\n- β±οΈ Fast [Time Travel](https://loro.dev/docs/tutorial/time_travel) Through History\n\nhttps://github.com/loro-dev/loro/assets/18425020/ec2d20a3-3d8c-4483-a601-b200243c9792\n\n# Example\n\n[](https://stackblitz.com/edit/loro-basic-test?file=test%2Floro-sync.test.ts)\n\n```ts\nimport { expect, test } from 'vitest';\nimport { Loro, LoroList } from 'loro-crdt';\n\n/**\n * Demonstrates synchronization of two documents with two rounds of exchanges.\n */\n// Initialize document A\nconst docA = new Loro();\nconst listA: LoroList = docA.getList('list');\nlistA.insert(0, 'A');\nlistA.insert(1, 'B');\nlistA.insert(2, 'C');\n\n// Export the state of document A as a byte array\nconst bytes: Uint8Array = docA.exportFrom();\n\n// Simulate sending `bytes` across the network to another peer, B\nconst docB = new Loro();\n// Peer B imports the updates from A\ndocB.import(bytes);\n\n// Verify that B's state matches A's state\nexpect(docB.toJSON()).toStrictEqual({\n list: ['A', 'B', 'C'],\n});\n\n// Get the current operation log version of document B\nconst version = docB.oplogVersion();\n\n// Simulate editing at B: delete item 'B'\nconst listB: LoroList = docB.getList('list');\nlistB.delete(1, 1);\n\n// Export the updates from B since the last synchronization point\nconst bytesB: Uint8Array = docB.exportFrom(version);\n\n// Simulate sending `bytesB` back across the network to A\n// A imports the updates from B\ndocA.import(bytesB);\n\n// Verify that the list at A now matches the list at B after merging\nexpect(docA.toJSON()).toStrictEqual({\n list: ['A', 'C'],\n});\n```\n\n# Credits\n\nLoro draws inspiration from the innovative work of the following projects and individuals:\n\n- [Ink & Switch](https://inkandswitch.com/): The principles of Local-first Software have greatly influenced this project. The [Peritext](https://www.inkandswitch.com/peritext/) project has also shaped our approach to rich text CRDTs.\n- [Diamond-types](https://github.com/josephg/diamond-types): The [Replayable Event Graph (REG)](https://loro.dev/docs/advanced/replayable_event_graph) algorithm from @josephg has been adapted to reduce the computation and space usage of CRDTs.\n- [Automerge](https://github.com/automerge/automerge): Their use of columnar encoding for CRDTs has informed our strategies for efficient data encoding.\n- [Yjs](https://github.com/yjs/yjs): We have incorporated a similar algorithm for effectively merging collaborative editing operations, thanks to their pioneering works.\n- [Matthew Weidner](https://mattweidner.com/): His work on the [Fugue](https://arxiv.org/abs/2305.00583) algorithm has been invaluable, enhancing our text editing capabilities.\n- [Martin Kleppmann](https://martin.kleppmann.com/): His work on CRDTs has significantly influenced our comprehension of the field.\n \n\n[local-first]: https://www.inkandswitch.com/local-first/\n[Fugue]: https://arxiv.org/abs/2305.00583\n[Peritext]: https://www.inkandswitch.com/peritext/\n","readmeFilename":"README.md"}![\"\"](\"https://img.shields.io/badge/Twitter-black?style=for-the-badge&logo=Twitter\"){kind=icon}
\n ![\"\"](\"https://img.shields.io/badge/Discord-black?style=for-the-badge&logo=discord\"){kind=icon}
\n