js-waku-examples/README.md

39 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2022-10-28 03:17:15 +00:00
# Js-Waku Examples
2022-06-17 00:48:15 +00:00
## Examples
2022-06-17 00:49:30 +00:00
Here is the list of the examples using [`js-waku`](https://www.npmjs.com/package/js-waku) and the features they demonstrate:
2022-06-17 00:48:15 +00:00
See https://examples.waku.org/ for more examples.
2022-10-28 03:17:15 +00:00
### Ethereum Private Messaging
End-to-end encrypted communication between two Ethereum addresses.
- [code](examples/eth-pm)
2022-10-28 03:17:15 +00:00
- [website](https://examples.waku.org/eth-pm)
- Demonstrates: Private Messaging, React/TypeScript, Light Client, Signature with Web3, Asymmetric Encryption.
### Using Waku Store in JavaScript
This example uses Waku Store to retrieve the latest ping relay message (used for keep alive purposes) and displays its timestamp.
- [code](examples/store-js)
2022-10-28 03:17:15 +00:00
- [website](https://examples.waku.org/store-js)
- Demonstrates: Waku Store: Using a condition to stop retrieving results from Waku Store, Pure Javascript/HTML using ESM/unpkg bundle.
### Minimal ReactJS Waku Store App
2023-07-12 10:11:30 +00:00
A simple app that retrieves chat messages using [Waku Store](https://docs.waku.org/overview/concepts/protocols#store) to illustrate the retrieval of messages with `js-waku` and ReactJS.
2022-10-28 03:17:15 +00:00
- [code](examples/store-reactjs-chat)
2022-10-28 03:17:15 +00:00
- [website](https://examples.waku.org/store-reactjs-chat)
- Demonstrates: React/JavaScript, Waku Store, Protobuf using `protobufjs`, no async/await syntax.
# Continuous Integration
The `master` branch is being built by Jenkins CI:
https://ci.infra.status.im/job/website/job/examples.waku.org/
Based on the [`ci/Jenkinsfile`](./ci/Jenkinsfile).