# @syncedstore/core
> SyncedStore is an easy-to-use library for building collaborative applications that sync automatically. It's built on top of Yjs, a proven, high performance CRDT implementation.
Latest version **0.6.0** (published 2023-10-15) · MIT license · 0 weekly downloads
## Install
```sh
npm install @syncedstore/core
pnpm add @syncedstore/core
yarn add @syncedstore/core
bun add @syncedstore/core
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.6.0 |
| Published | 2023-10-15 |
| First published | 2021-11-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 289.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | yousefed |
| Keywords | reactive, crdt, yjs, react, sync, automerge, collaboration, collaborative, mobx, vue, vuejs, observable, operational transforms, conflict, offline, shared editing |
## Links
- npm: https://www.npmjs.com/package/@syncedstore/core
- Homepage: https://syncedstore.org
- npm.io page: https://npm.io/package/@syncedstore/core
## Dependencies (2)
- [@reactivedata/reactive](https://npm.io/package/@reactivedata/reactive.md) ^0.2.0
- [@syncedstore/yjs-reactive-bindings](https://npm.io/package/@syncedstore/yjs-reactive-bindings.md) ^0.6.0
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 0.6.0 (latest) — 2023-10-15
- 0.6.0-alpha.0 — 2023-08-23
- 0.5.2 — 2023-07-14
- 0.5.1 — 2023-04-14
- 0.4.3 — 2023-01-31
- 0.4.2 — 2022-10-28
- 0.4.1 — 2022-08-02
- 0.4.0 — 2022-08-02
- 0.3.9 — 2022-04-20
- 0.3.7 — 2022-02-01
- 0.3.5 — 2022-01-02
- 0.3.4 — 2021-11-12
- 0.3.3 — 2021-11-11
- 0.3.2 — 2021-11-11
- 0.3.0 — 2021-11-11
## README
# SyncedStore CRDT
[](https://badge.fury.io/js/%40syncedstore%2Fcore) [](https://coveralls.io/github/YousefED/SyncedStore?branch=main)
(This library was previously called "Reactive-CRDT")
SyncedStore is an easy-to-use library for building collaborative applications that sync automatically. It's built on top of [Yjs](https://github.com/yjs/yjs), a proven, high performance CRDT implementation.
## TL;DR
Create apps like this:
[](https://syncedstore.org/docs/react)
_[Play with this example](https://syncedstore.org/docs/react)_
Using an API as simple as this:
```typescript
// add a todo
store.todos.push({ completed: false, title: "Get groceries" });
// set todo to completed
store.todos[0].completed = true;
```
# Documentation
### [View the documentation with interactive code samples](https://syncedstore.org/docs/)
You can find the SyncedStore documentation
[on the website](https://syncedstore.org/).
- [Getting Started](https://syncedstore.org/docs/basics/installation)
- [Working with React](https://syncedstore.org/docs/react)
- [Working with Vue](https://syncedstore.org/docs/vue)
- [Working with Svelte](https://syncedstore.org/docs/svelte)
- [Collaborative text editing](https://syncedstore.org/docs/advanced/richtext)
- [Sync providers](https://syncedstore.org/docs/sync-providers)
## Examples
We have several examples [on the website](https://syncedstore.org/) ([React](https://syncedstore.org/docs/react), [Vue](https://syncedstore.org/docs/vue), [Svelte](https://syncedstore.org/docs/svelte)) as part of the documentation.
In this repository, there are also more complex examples based on TodoMVC ([examples/todo-react](https://github.com/YousefED/syncedstore/tree/main/examples/todo-react), [examples/todo-vue](https://github.com/YousefED/syncedstore/tree/main/examples/todo-vue), [examples/todo-svelte](https://github.com/YousefED/syncedstore/tree/main/examples/todo-svelte)).
[](https://github.com/YousefED/syncedstore/tree/main/examples/)
- Open live demo: [React](https://ze3vo.csb.app/) or [Vue](https://uie1c.csb.app/) (Of course, open multiple times to test multiplayer)
- Edit / view on Codesandbox [React](https://codesandbox.io/s/todo-react-ze3vo) / [Vue](https://codesandbox.io/s/todo-vue-uie1c)
# Motivation
SyncedStore makes it easy to develop applications that:
- 👨👩👧👦 **Are collaborative**: create multi-user and multi-device experiences without the need to handle complex conflict resolution management yourself.
- 🚀 **Are fast**: operations are handled locally, and data synchronization with other users and devices happens quietly in the background. 0 Latency!
- 🔗 **Work offline**: cloud apps typically don’t work while offline. Supporting both data sync and offline used to be difficult, SyncedStore aims to simplify this.
Perhaps most importantly, it makes it easy to build **decentralized applications**. This has a lot of security & privacy benefits compared to always relying on central (expensive) servers to keep track of all our data.
> Read more about [the benefits of Local-first software in this essay](https://www.inkandswitch.com/local-first.html)
In short, with some technological magic of so-called [CRDTs](https://crdt.tech/) (_Conflict-free Replicated Data Types_), we can build _cross-device_ apps that are _more collaborative_, _faster_, _work offline_ AND put the user _back in control of their data_.
# Feedback
I'd always love to hear how you're using SyncedStore. Definitely open an issue if you need help, get in touch via [Twitter](https://www.twitter.com/yousefed), or join the discussion in the [Yjs forums](https://discuss.yjs.dev/).
# Credits ❤️
SyncedStore builds directly on [Yjs](https://github.com/yjs/yjs) and [Reactive](https://www.github.com/yousefed/reactive). It's also inspired by and builds upon the amazing work by [MobX](https://mobx.js.org/) and [NX Observe](https://github.com/nx-js/observer-util).
SyncedStore is built as part of [TypeCell](https://www.typecell.org). TypeCell is proudly sponsored by the renowned [NLNet foundation](https://nlnet.nl/foundation/) who are on a mission to support an open internet, and protect the privacy and security of internet users. Check them out!
---
_Source: https://npm.io/package/@syncedstore/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._