Skip to content

Yorkie is a document store for collaborative applications.

License

Notifications You must be signed in to change notification settings

yorkie-team/yorkie

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

56fb0eb · Dec 12, 2023
Dec 4, 2023
Dec 12, 2023
Dec 11, 2023
Dec 7, 2023
Dec 12, 2023
Dec 7, 2023
Dec 7, 2023
Apr 21, 2023
Dec 4, 2023
Dec 12, 2023
Dec 12, 2023
Apr 19, 2023
Apr 11, 2023
Oct 8, 2022
Dec 4, 2023
Aug 7, 2023
Dec 7, 2023
Mar 1, 2020
Oct 18, 2023
Dec 11, 2023
Jan 26, 2023
Jun 6, 2023
Dec 11, 2023
Aug 5, 2022
May 25, 2021
Dec 12, 2023
Dec 7, 2023

Repository files navigation

Yorkie

GitHub Twitter Discord Contributors Commits

Build Status Go Report Card CodeCov Godoc

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

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

 Client "A" (Go)                 Server                       MemDB or MongoDB
┌───────────────────┐           ┌────────────────────────┐   ┌───────────┐
│  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: {} }  │  │
└───────────────────┘           │ └───────────────────┘  │
 Admin (CLI, Web)               │                        │
┌────────────────────┐          └────────────────────────┘
│  Query "Q-1"       │              ▲
│  P-1.find({a:2})   ├───── Query───┘
└────────────────────┘
  • Clients can have a replica of the document representing an application model locally on several devices.
  • Each client can independently update the document on their local device, even while offline.
  • 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.
  • 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 conflict.

SDKs

Yorkie provides SDKs for Go, JavaScript, iOS, and Android:

Documentation

Full, comprehensive documentation is available on the Yorkie website.

Getting Started

Contributing

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

Contributors ✨

Thanks go to these incredible people:

contributors

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.