fix: examples links (#61)

Co-authored-by: Franck Royer <franck@status.im>
This commit is contained in:
fryorcraken.eth 2022-10-28 15:24:11 +11:00 committed by GitHub
parent 8d238368e8
commit 9712fae285
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 97 deletions

View File

@ -6,108 +6,17 @@ weight: 40
# Examples
Here is the list of the code examples and the features they demonstrate.
To run or studies the example, click on the _code_ links.
## JS-Waku Examples Repository
## Minimal ReactJS Chat App
We maintain a number of examples in the [waku-org/js-waku-examples](https://github.com/waku-org/js-waku-examples#readme) repository.
Code: [relay-reactjs-chat](https://github.com/status-im/js-waku/tree/master/examples/relay-reactjs-chat).
These examples use the latest published version of js-waku.
Demonstrates:
## Community Examples
- Group chat
- React/JavaScript
- Waku Relay
- Protobuf using [protons](https://www.npmjs.com/package/protons)
- No async/await syntax
Here are examples from the community.
## Minimal ReactJS Waku Store App
Code: [store-reactjs-chat](https://github.com/status-im/js-waku/tree/master/examples/store-reactjs-chat).
Demonstrates:
- Waku Store
- React/JavaScript
- Protobuf using [protons](https://www.npmjs.com/package/protons)
## Minimal Angular Chat App
Code: [relay-angular-chat](https://github.com/status-im/js-waku/tree/master/examples/relay-angular-chat).
Demonstrates:
- Group chat
- Angular/JavaScript
- Waku Relay
- Protobuf using [protons](https://www.npmjs.com/package/protons)
- No async/await syntax
- Observables
## Using Waku Store in JavaScript With Minified Library
Code: [store-js](https://github.com/status-im/js-waku/tree/master/examples/store-js).
Demonstrates:
- How to stop retrieving results from Waku Store on condition
- Use minified bundle from unpkg.com
- Pure JavaScript application
## Using Waku Relay in JavaScript With Minified Library
Code: [relay-js](https://github.com/status-im/js-waku/tree/master/examples/relay-js).
Demonstrates:
- Waku Relay: Send and receive messages using Waku Relay
- Use minified bundle from unpkg.com
- Pure JavaScript application
## Web Chat App
Code: [web-chat](https://github.com/status-im/js-waku/tree/master/examples/web-chat).
Live: https://js-waku.wakuconnect.dev/examples/web-chat/
Demonstrates:
- Group chat
- React/TypeScript
- Waku Relay
- Waku Store
- Protobuf using .proto files + [bufbuild](https://github.com/bufbuild/buf) + [ts-proto](https://www.npmjs.com/package/ts-proto)
## Ethereum Private Message Web App
Code: [eth-pm](https://github.com/status-im/js-waku/tree/master/examples/eth-pm).
Live: https://js-waku.wakuconnect.dev/examples/eth-pm/
Demonstrates:
- Private messaging
- React/TypeScript
- Waku Light Push
- Signature with Web3 Wallet
- Asymmetric Encryption
- Symmetric Encryption
- Protobuf using [protobufjs](https://www.npmjs.com/package/protobufjs)
## Ethereum Private Message Using Web3 Wallet Encryption API Web App
Code: [eth-pm-wallet-encryption](https://github.com/status-im/js-waku/tree/master/examples/eth-pm-wallet-encryption).
Live: https://js-waku.wakuconnect.dev/examples/eth-pm-wallet-encryption/
Demonstrates:
- Private Messaging
- React/TypeScript
- Waku Light Push
- Signature with Web3 using EIP-712: `eth_signTypedData_v4`
- Asymmetric Encryption
- Usage of `eth_decrypt` Web3 Wallet API
- Protobuf using [protobufjs](https://www.npmjs.com/package/protobufjs)
## Uber-like minimalistic car sharing app suing Vue.js
### Uber-like minimalistic car sharing app suing Vue.js
Code: [TheBojda/waku-uber](https://github.com/TheBojda/waku-uber).