README.md

Yorkie

Yorkie is an open-source document store for building real-time collaborative applications. It uses JSON-like documents(CRDT) with optional types.

Yorkie consists of three main components: Client, Document and Server.

 Client "A" (Go)               Server(Cloud or Self-Hosted)  MongoDB or MemDB
┌───────────────────┐           ┌────────────────────────┐   ┌───────────┐
│  Document "D-1"   │◄─Changes─►│  Project "P-1"         │   │ Changes   │
│  { a: 1, b: {} }  │           │ ┌───────────────────┐  │◄─►│ Snapshots │
└───────────────────┘           │ │  Document "D-1"   │  │   └───────────┘
 Client "B" (JS)                │ │  { a: 2, b: {} }  │  │
┌───────────────────┐           │ │                   │  │
│  Document "D-1"   │◄─Changes─►│ │  Document "D-2"   │  │
│  { a: 2, b: {} }  │           │ │  { a: 3, b: {} }  │  │
└───────────────────┘           │ └───────────────────┘  │
 Dashboard or CLI               └────────────────────────┘
┌────────────────────┐              ▲
│  Query "Q-1"       │              |
│  P-1.find({a:2})   ├───── Query───┘
└────────────────────┘

Key Features:

• Clients: Clients can have a local replica of the document representing an application model on several devices.
• Offline Editing: Each client can independently update the document on their local device, even while offline.
• Synchronization: When a network connection is available, the client figures out which changes need to be synced from one device to another, and brings them into the same state.
• Conflict Resolution: If the document was changed concurrently on different devices, Yorkie automatically syncs the changes, so that every replica ends up in the same state with resolving conflicts.
• Database Integration: Yorkie supports MongoDB and MemDB as the underlying data storage.

Documentation

Full, comprehensive documentation is available on the Yorkie website.

Getting Started

• with JS SDK
• with iOS SDK
• with Android SDK

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Contributors ✨

Thanks go to these incredible people:

Sponsors

Is your company using Yorkie? Ask your boss to support us. It will help us dedicate more time to maintain this project and to make it even better for all our users. Also, your company logo will show up on here and on our website: -) [Become a sponsor]

Backers

Please be our Backers.