https://github.com/molekilla/y-fdp-storage-demo-app

demo app
https://github.com/molekilla/y-fdp-storage-demo-app

Last synced: 3 days ago
JSON representation

demo app

• Host: GitHub
• URL: https://github.com/molekilla/y-fdp-storage-demo-app
• Owner: molekilla
• Created: 2023-03-16T14:02:54.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-03-24T15:35:02.000Z (over 1 year ago)
• Last Synced: 2024-04-10T02:56:46.966Z (7 months ago)
• Language: TypeScript
• Homepage: https://y-fdp-storage-demo-app.vercel.app
• Size: 544 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## y-fdp-storage demo app

## How to execute demo app

[Untitled_ Mar 24, 2023 10_32 AM.webm](https://user-images.githubusercontent.com/1248071/227571255-0f4e6c54-a2cf-49ff-b837-c62617250be5.webm)

1. Configure environment variables in a .env file and then run fdp-play. If you need a postage stamp, run unit tests found in `y-fdp-storage` and enable postage stamps seed in jest setup.

```yaml

# example

REACT_APP_BEE_URL=http://localhost:1633

REACT_APP_BEE_POSTAGE=1c082c5e642e15d49b6689f5437c2eb9e6aa9c546a8ed1d11d0024b043bca371

```

2. Install demo with `npm i`

3. Run react app with `npm run start`

4. Open `http://localhost:3000` in two different tabs

5. Fill in `Private Key` and `Document Name` value and click Connect

6. Write anything in text editor

7. Wait a few seconds and watch editors being synchronized

## How it works

`y-fdp-storage` uses Yjs as CRDT sync mechanism while storing data in Swarm using a Swarm Sequence Feed. To grab the latest updates, `y-fdp-storage` long-polls `setLastUpdate` on the sequence feeds and auto updates inside a `setInterval` to the swarm feed.

## Requirements

A `fdp-play` environment or a Bee RPC url plus its batch id.