crdt_sync 0.0.2

A dart-native turnkey solution for painless network synchronization

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 package is still under development and may not be stable. The API may break at any time.

Usage

crdt_sync uses sql_crdt for data storage, so you'll need to instantiate one of sqlite_crdt or postgres_crdt.

You'll most likely want to store your server data in PostgresCrdt, and client data in SqliteCrdt, however the following sample code will just use a transient SqliteCrdt database for the sake of simplicity:

final crdt = await SqliteCrdt.openInMemory(…);

Server

Instantiate a CrdtSyncServer and start listening for connections:

final server = CrdtSyncServer(crdt);
server.listen(8080);

Alternatively, CrdtSyncServer can adopt a HttpRequest or WebSocket directly making it easy to integrate with Shelf and other server frameworks.

Client

Instantiate a CrdtSyncClient and order it to start connecting:

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 for a more complete solution.

Features and bugs

Please file feature requests and bugs in the issue tracker.