Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cachapa/crdt_sync
A dart-native turnkey solution for painless network synchronization
https://github.com/cachapa/crdt_sync
crdt sql websocket
Last synced: 6 days ago
JSON representation
A dart-native turnkey solution for painless network synchronization
- Host: GitHub
- URL: https://github.com/cachapa/crdt_sync
- Owner: cachapa
- License: apache-2.0
- Created: 2023-08-08T05:13:16.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-02T09:17:32.000Z (3 months ago)
- Last Synced: 2024-11-20T21:58:43.707Z (2 months ago)
- Topics: crdt, sql, websocket
- Language: Dart
- Homepage: https://pub.dev/packages/crdt_sync
- Size: 61.5 KB
- Stars: 19
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# crdt_sync
A Dart-native turnkey solution for painless network synchronization.
`crdt_sync` takes care of the network plumbing between your app and backend to build products that are:
* Offline-first: Apps primarily work with a local store independent of network connectivity.
* Real-time: When online, the local store immediately and continuously synchronizes with the backend.
* Efficient: Synchronization relies on delta changesets to optimize the amount of data sent over the wire.
* Portable: All communication happens over a single standard WebSocket making it compatible with most network configurations.
This library is compatible with the `crdt` package and all of its implementations. It uses a standard communication protocol which abstracts the underlying storage method. This results in the dubious ability to synchronize SQL nodes with No-SQL ones. I don't judge.
See [crdt](https://github.com/cachapa/crdt) for more details and a list of existing implementations.
## Usage
You'll most likely want to use a persistent `crdt` store, however the following sample code uses an ephemeral `MapCrdt` for the sake of simplicity:
```dart
final crdt = MapCrdt(['chat']);
```
### Server
Start listening for connections:
```dart
listen(crdt, 8080);
```
Alternatively, you can use `upgrade()` to adopt an `HttpRequest`, or `CrdtSync.server()` to manage a `WebSocket` directly making it easy to integrate with [Shelf](https://pub.dev/packages/shelf) and other server frameworks.
See [tudo_server](https://github.com/cachapa/tudo_server) for a real world example.
### Client
Instantiate a `CrdtSyncClient` and order it to start connecting:
```dart
final client = CrdtSyncClient(crdt, Uri.parse('ws://localhost:8080'));
client.connect();
```
Once `connect()` is called, the client will continuously attempt to establish or resume a connection until it succeeds, or until `disconnect()` is called.
See the included [example](https://github.com/cachapa/crdt_sync/blob/master/example/example.dart) for a more complete solution, or [tudo](https://github.com/cachapa/tudo) for a real-world application.
## Features and bugs
Please file feature requests and bugs in the [issue tracker](https://github.com/cachapa/crdt_sync/issues).