https://github.com/clintharris/crdt-example-app_annotated

A fork of James Long's CRDT example app, annotated with extra code comments and a NOTES.md
https://github.com/clintharris/crdt-example-app_annotated

Last synced: 20 days ago
JSON representation

A fork of James Long's CRDT example app, annotated with extra code comments and a NOTES.md

• Host: GitHub
• URL: https://github.com/clintharris/crdt-example-app_annotated
• Owner: clintharris
• Fork: true (jlongster/crdt-example-app)
• Created: 2020-02-02T15:52:31.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-04T07:05:58.000Z (almost 3 years ago)
• Last Synced: 2024-02-17T11:38:44.042Z (9 months ago)
• Language: JavaScript
• Homepage: https://crdt.jlongster.com
• Size: 154 KB
• Stars: 41
• Watchers: 3
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

This is a demo app used for my dotJS 2019 talk "CRDTs for Mortals".

Slides here: https://jlongster.com/s/dotjs-crdt-slides.pdf

View this app here: https://crdt.jlongster.com

It contains a full implementation of [hybrid logical clocks](https://cse.buffalo.edu/tech-reports/2014-04.pdf) to generate timestamp for causal ordering of messages. Using these timestamps, CRDTs can be easily used to change local data that also syncs to multiple devices. This also contains an implementation of a merkle tree to check consistency of the data to make sure all clients are in sync.

It provides a server to store and retrieve messages, so that clients don't have to connect peer-to-peer.

The entire implementation is tiny, but provides a robust mechanism for writing distributed apps:

* Server: 132 lines of JS

* Client: 639 lines of JS

(This does not include `main.js` in the client which is the implementation of the app. This is just showing the tiny size of everything needed to build an app)

Links:

* Actual: https://actualbudget.com/

* Hybrid logical clocks: https://cse.buffalo.edu/tech-reports/2014-04.pdf

* CRDTs: https://bit.ly/2DMk0AD

* Live app: https://crdt.jlongster.com/

## How to Run

You can just open `client/index.html` in a browser (i.e., access via `file://` URI). Alternatively, you can serve it from a web server (e.g., `npx serve` and open `http://localhost:5000/client/`).

By default, the UI will sync with the data hosted at `https://crdt.jlongster.com/server/sync`. See instructions below for syncing with your own local server.

### Optional: Run the server to sync with your own database

1. `yarn install`

2. `./run` to start the server (this will create `server/db.sqlite`).

3. Open `server/db.sqlite` in a SQLite client and run `server/init.sql` to create the schema.

4. Modify the UI to sync with your local server: edit `client/sync.js:post()` to use `http://localhost:8006/sync` instead of `https://crdt.jlongster.com/server/sync`.