Skip to content

Latest commit

 

History

History
83 lines (54 loc) · 3.14 KB

README.md

File metadata and controls

83 lines (54 loc) · 3.14 KB
Raw

todomvc

uses online and offline replication to create real-time and perserved P2P applications

Web app base is from todomvc.com

Built with welo

Demo video

todomvc-demo.mov

Running the demo

Have only tested the webapp using chromium browsers.

Prerequisites

  • web3.storage API token

Create .env file

In the project root create a file named .env and write:

REACT_APP_W3_TOKEN='<your web3.storage token here>'

Start Circuit-Relay Server

In a separate prompt, start a local relay-server using the command:

$ npm run relay

It may take a minute or two before the relay server can be used by the browser clients. Everything should be functional after seeing a debug log like this:

  libp2p:circuit-relay:advert-service:error could not advertise service AbortError: Query was aborted before self-query ran
    at EventTarget.<anonymous> (file:///home/tabcat/github/hldb/todomvc/node_modules/@libp2p/kad-dht/dist/src/query/manager.js:104:36)
    at [nodejs.internal.kHybridDispatch] (node:internal/event_target:731:20)
    at EventTarget.dispatchEvent (node:internal/event_target:673:26)
    at abortSignal (node:internal/abort_controller:308:10)
    at AbortController.abort (node:internal/abort_controller:338:5)
    at EventTarget.onAbort (file:///home/tabcat/github/hldb/todomvc/node_modules/any-signal/dist/src/index.js:8:20)
    at [nodejs.internal.kHybridDispatch] (node:internal/event_target:731:20)
    at EventTarget.dispatchEvent (node:internal/event_target:673:26)
    at abortSignal (node:internal/abort_controller:308:10)
    at Timeout._onTimeout (node:internal/abort_controller:115:7) {
  code: 'ABORT_ERR',
  type: 'aborted'
} +0ms

Start Dev Server

In a separate terminal, start hosting the webapp locally by using the command:

$ npm run start

Testing Live Replication

Using a browser, navigate to localhost:3000. Open another tab for the same url.

Begin making changes on either side. After a few moments the browser clients should find eachother over pubsub and updates can be observed immediately on the other side. Open more tabs if you like.

Testing Offline Replication

Using a browser, navigate to localhost:3000.

Make changes to the todo list. Wait a moment for the changes to be uploaded. (not currently part of the UI but upload events can be observed in the console)

Reload the tab, this will wipe all previous data. After the new browser libp2p instance has connected to the local circuit-relay server the changes advertised by the previous instance can be queried from the dht, then w3name, and finally pulled from web3.storage.

Demo topology

There is helia instance running in the browser which connects to public dev webrtc-star servers. The browser clients also connect to a local circuit-relay server, clients use the /webrtc multiaddr to write to the lan DHT. Clients will upload their immutable changes to web3.storage and advertise them either over pubsub with other online peers, or using the DHT and w3name for later use by currently offline peers.