waku-org
/
js-waku-lab
mirror of https://github.com/waku-org/js-waku-lab.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: update links and text

This commit is contained in:
Sasha 2024-01-09 00:27:30 +01:00
parent 7f3b898f2c
commit 7312249133
No known key found for this signature in database
9 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -4,6 +4,7 @@
This repository is dedicated for proof of concepts, examples and research done around core Waku libraries.
Repo is hosted at https://lab.waku.org/
See https://examples.waku.org/ for more examples.
### Web Chat App

2
examples/light-js/README.md
View File

@ -10,4 +10,4 @@ This example uses Waku Filter to listen to messages and Waku Light Push to send
To test the example, simply download the `index.html` file from this folder and open it in a browser.
The `master` branch's HEAD is deployed at https://examples.waku.org/light-js/.
The `master` branch's HEAD is deployed at https://lab.waku.org/light-js/.

3
examples/noise-js/README.md
View File

@ -4,4 +4,5 @@
npm install
npm start
```
Browse to http://localhost:8080
Browse to http://localhost:8080
The `master` branch's HEAD is deployed at https://lab.waku.org/noise-js/

4
examples/noise-rtc/README.md
View File

@ -8,4 +8,6 @@ What should be done:
- `STUN` server: in order not to loose benefits of peer-to-peer protocols used underneath we should find a way to be able to retrieve coordinates of a user to build `offer/answer` by not involving one `STUN` server for it;
- `TURN` server: similarly to prev point we should be able to cover a need to create WebRTC connection for users who are behind secure `NAT` and are not able to communicated just as it is.
Additional reading that explains why `STUN/TURN` is not easily removable from the equation: https://github.com/libp2p/specs/pull/497/files#diff-2cb0b0dcc282bd123b21f5a0610e8a01b516fc453b95c655cf7e16734f2f7b11R48-R53
Additional reading that explains why `STUN/TURN` is not easily removable from the equation: https://github.com/libp2p/specs/pull/497/files#diff-2cb0b0dcc282bd123b21f5a0610e8a01b516fc453b95c655cf7e16734f2f7b11R48-R53
The `master` branch's HEAD is deployed at https://lab.waku.org/noise-rtc/

4
examples/relay-angular-chat/README.md
View File

@ -10,13 +10,13 @@
A barebone messaging app to illustrate the seamless integration of `js-waku` into AngularJS.
The `master` branch's HEAD is deployed at https://examples.waku.org/relay-angular-chat/.
The `master` branch's HEAD is deployed at https://lab.waku.org/relay-angular-chat/.
To run a development version locally, do:
```shell
git clone https://github.com/waku-org/js-waku-examples
cd js-waku-examples/examples/relay-angular-chat
cd waku-lab/examples/relay-angular-chat
npm install
npm start
```

2
examples/relay-direct-rtc/README.md
View File

@ -9,7 +9,7 @@ This example uses WebRTC transport and Waku Relay to exchange messages.
To test the example run `npm install` and then `npm start`.
The `master` branch's HEAD is deployed at https://examples.waku.org/relay-direct-chat/.
The `master` branch's HEAD is deployed at https://lab.waku.org/relay-direct-chat/
### Steps to run an example:
1. Get a Waku node that implements `/libp2p/circuit/relay/0.2.0/hop` and `/libp2p/circuit/relay/0.2.0/stop`

2
examples/relay-js/README.md
View File

@ -10,4 +10,4 @@ This example uses Waku Relay to send and receive simple text messages.
To test the example, simply download the `index.html` file from this folder and open it in a browser.
The `master` branch's HEAD is deployed at https://examples.waku.org/relay-js/.
The `master` branch's HEAD is deployed at https://lab.waku.org/relay-js/

7
examples/relay-reactjs-chat/README.md
View File

@ -4,19 +4,18 @@
- Group chat
- React/JavaScript
- `create-react-app`/`react-scripts` 5.0.0
- Waku Relay
- Protobuf using `protobufjs`.
A barebone chat app to illustrate the seamless integration of `js-waku` into ReactJS.
The `master` branch's HEAD is deployed at https://examples.waku.org/relay-reactjs-chat/.
The `master` branch's HEAD is deployed at https://lab.waku.org/relay-reactjs-chat/.
To run a development version locally, do:
```shell
git clone https://github.com/waku-org/js-waku-examples
cd js-waku-examples/examples/relay-reactjs-chat
git clone https://github.com/waku-org/waku-lab
cd waku-lab/examples/relay-reactjs-chat
npm install
npm run start
```

6
examples/web-chat/README.md
View File

@ -11,13 +11,13 @@
A ReactJS chat app is provided as a showcase of the library used in the browser.
It implements [Waku v2 Toy Chat](https://rfc.vac.dev/spec/22/) protocol.
A deployed version is available at https://examples.waku.org/web-chat/.
A deployed version is available at https://lab.waku.org/web-chat/.
To run a development version locally, do:
```shell
git clone https://github.com/waku-org/js-waku-examples
cd js-waku-examples/examples/web-chat
git clone https://github.com/waku-org/waku-lab
cd waku-lab/examples/web-chat
npm install
npm run start
```