logos-messaging/examples.waku.org
1
0
Fork 0
mirror of https://github.com/logos-messaging/examples.waku.org.git synced 2026-01-02 12:53:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme and texts

Browse Source
This commit is contained in:
Sasha 2023-08-30 01:10:11 +02:00
parent bb06af386b
commit bce883a39e
No known key found for this signature in database
3 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
examples/relay-chat/README.md
View File

@ -1,13 +1,23 @@
# Using Waku Light Push and Filter in JavaScript
# Using Waku Relay WebRTC
**Demonstrates**:
- Waku Light node: Waku Filter + Waku Light Push
- Waku Relay node with direct WebRTC connection
- Pure Javascript/HTML.
- Use minified bundle of js from unpkg.com, no import, no package manager.
This example uses Waku Filter to listen to messages and Waku Light Push to send messages.
To test the example, simply download the `index.html` file from this folder and open it in a browser.
To test the example run `npm install` and then `npm start`.
The `master` branch's HEAD is deployed at https://examples.waku.org/light-js/.
The `master` branch's HEAD is deployed at https://examples.waku.org/relay-chat/.
### Steps to run an example:
1. Build and then run `go-waku` node with following command: `./build/waku --ws true --relay true --circuit-relay true`
2. Copy node's multiaddr (e.g `/ip4/192.168.0.101/tcp/60001/ws/p2p/16Uiu2HAm9w2xeDWFJm5eeGLZfJdaPtkNatQD1xrzK5EFWSeXdFvu`)
3. In `relay-chat` example's folder run `npm install` and then `npm start`
4. Use `go-waku`'s multiaddr for **Remote node multiaddr** and press dial. Repeat in two more tabs.
5. In `tab2` copy **Local Peer Id** and use as **WebRTC Peer** in `tab1` and press dial.
6. In `tab1` or `tab2` press **Ensure WebRTC Relay connection**
7. In `tab1` press **Drop non WebRTC connections**
8. In `tab1` enter **Nickname** and **Message** and send.
9. See the message in `tab3` which was connected only to `go-waku` node.

2
examples/relay-chat/index.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8" />
<meta content="width=device-width, initial-scale=1.0" name="viewport" />
<title>JS-Waku light chat</title>
<title>JS-Waku WebRTC Relay</title>
<link rel="stylesheet" href="./style.css" />
<link rel="apple-touch-icon" href="./favicon.png" />
<link rel="manifest" href="./manifest.json" />

4
examples/relay-chat/manifest.json
View File

@ -1,6 +1,6 @@
{
"name": "Light JS",
"description": "Send messages between several users (or just one) using light client targeted protocols.",
"name": "Waku Relay WebRTC JS",
"description": "Send messages between several users (or just one) using Relay with direct WebRTC connection.",
"icons": [
{
"src": "favicon.ico",