2024-01-08 23:01:53 +00:00
|
|
|
# Waku Lab
|
|
|
|
|
|
|
|
|
|
## Description
|
|
|
|
|
|
2024-01-10 21:38:27 +00:00
|
|
|
This repository is dedicated to experimental proof of concepts and research related to js-waku libraries.
|
2024-01-08 23:01:53 +00:00
|
|
|
|
2024-01-10 21:38:27 +00:00
|
|
|
Webapps in this repo are hosted at https://lab.waku.org/
|
|
|
|
|
For ready-to-use examples to build with js-waku. Go to https://examples.waku.org/
|
2024-01-08 23:01:53 +00:00
|
|
|
|
2024-04-24 05:23:47 +00:00
|
|
|
### Notes App
|
|
|
|
|
|
|
|
|
|
- [code](examples/flush-notes)
|
|
|
|
|
- [website](https://lab.waku.org/flush-notes)
|
|
|
|
|
- Demonstrates: Light Push, Filter, Store, Message encryption/decryption
|
|
|
|
|
|
|
|
|
|
## Experimental Examples
|
|
|
|
|
|
|
|
|
|
The following examples are not as actively maintained as the above and may not work with latest js-waku packages.
|
|
|
|
|
|
2024-01-08 23:01:53 +00:00
|
|
|
### Web Chat App
|
|
|
|
|
|
2024-04-24 05:23:47 +00:00
|
|
|
- [code](examples/experimental/web-chat)
|
|
|
|
|
- [website](https://lab.waku.org/experimental/web-chat)
|
2024-01-08 23:01:53 +00:00
|
|
|
- Demonstrates: Group chat, React/TypeScript, Relay, Store.
|
|
|
|
|
|
|
|
|
|
### Waku Light Client in JavaScript
|
|
|
|
|
|
|
|
|
|
Send messages between several users (or just one) using light client targetted protocols.
|
|
|
|
|
|
2024-04-24 05:23:47 +00:00
|
|
|
- [code](examples/experimental/light-js)
|
|
|
|
|
- [website](https://lab.waku.org/experimental/light-js)
|
2024-01-08 23:01:53 +00:00
|
|
|
- Demonstrates: Waku Light node: Filter + Light Push, Pure Javascript/HTML using ESM/unpkg bundle.
|
|
|
|
|
|
|
|
|
|
### Waku Relay in JavaScript
|
|
|
|
|
|
|
|
|
|
This example uses Waku Relay to send and receive simple text messages.
|
|
|
|
|
|
2024-04-24 05:23:47 +00:00
|
|
|
- [code](examples/experimental/relay-js)
|
|
|
|
|
- [website](https://lab.waku.org/experimental/relay-js)
|
2024-01-08 23:01:53 +00:00
|
|
|
- Demonstrates: Waku Relay, Pure Javascript/HTML using ESM/unpkg bundle.
|
|
|
|
|
|
|
|
|
|
### Noise JS
|
|
|
|
|
|
2024-04-24 05:23:47 +00:00
|
|
|
- [code](examples/experimental/noise-js)
|
|
|
|
|
- [website](https://lab.waku.org/experimental/noise-js)
|
2024-01-08 23:01:53 +00:00
|
|
|
- Demonstrates: LightPush, Filter, [Noise encryption](https://rfc.vac.dev/spec/35/).
|
|
|
|
|
|
|
|
|
|
### Noise RTC
|
|
|
|
|
|
2024-04-24 05:23:47 +00:00
|
|
|
- [code](examples/experimental/noise-rtc)
|
|
|
|
|
- [website](https://lab.waku.org/experimental/noise-rtc)
|
2024-01-08 23:01:53 +00:00
|
|
|
- Demonstrates: LightPush, Filter, [Noise encryption](https://rfc.vac.dev/spec/35/), WebRTC.
|
|
|
|
|
|
|
|
|
|
### Relay Direct RTC
|
|
|
|
|
|
2024-04-24 05:23:47 +00:00
|
|
|
- [code](examples/experimental/relay-direct-rtc)
|
|
|
|
|
- [website](https://lab.waku.org/experimental/relay-direct-rtc)
|
2024-01-08 23:01:53 +00:00
|
|
|
- Demonstrates: Relay over WebRTC.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Continuous Integration
|
|
|
|
|
|
|
|
|
|
The `master` branch is being built by Jenkins CI:
|
|
|
|
|
https://ci.infra.status.im/job/website/job/lab.waku.org/
|
|
|
|
|
|
|
|
|
|
Based on the [`ci/Jenkinsfile`](./ci/Jenkinsfile).
|
