Skip to content

Commit

Permalink
chore: update waku deps, add notes example, add experimental folder
Browse files Browse the repository at this point in the history
chore: update waku deps to latest
chore: remove relay chats, move all examples to experimental, add notes example
fix: notes example: use nightly waku deps and set pubsub topic in node/enc/dec
  • Loading branch information
adklempner committed Apr 24, 2024
1 parent ebf7beb commit 172d2f5
Show file tree
Hide file tree
Showing 576 changed files with 66,146 additions and 73,864 deletions.
15 changes: 7 additions & 8 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,13 @@ jobs:
matrix:
example:
[
relay-angular-chat,
relay-reactjs-chat,
web-chat,
noise-js,
noise-rtc,
relay-direct-rtc,
rln-js,
rln-identity
experimental/web-chat,
experimental/noise-js,
experimental/noise-rtc,
experimental/relay-direct-rtc,
experimental/rln-js,
experimental/rln-identity,
flush-notes
]
runs-on: ubuntu-latest
steps:
Expand Down
50 changes: 22 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,60 +7,54 @@ This repository is dedicated to experimental proof of concepts and research rela
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/

### 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.

### Web Chat App

- [code](examples/web-chat)
- [website](https://lab.waku.org/web-chat)
- [code](examples/experimental/web-chat)
- [website](https://lab.waku.org/experimental/web-chat)
- 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.

- [code](examples/light-js)
- [website](https://lab.waku.org/light-js)
- [code](examples/experimental/light-js)
- [website](https://lab.waku.org/experimental/light-js)
- Demonstrates: Waku Light node: Filter + Light Push, Pure Javascript/HTML using ESM/unpkg bundle.

### Minimal Angular (v13) Waku Relay

A barebone messaging app to illustrate the seamless integration of `js-waku` into AngularJS.

- [code](examples/relay-angular-chat)
- [website](https://lab.waku.org/relay-angular-chat)
- Demonstrates: Group messaging, Angular, Waku Relay, Protobuf using `protobufjs`, No async/await syntax.

### Waku Relay in JavaScript

This example uses Waku Relay to send and receive simple text messages.

- [code](examples/relay-js)
- [website](https://lab.waku.org/relay-js)
- [code](examples/experimental/relay-js)
- [website](https://lab.waku.org/experimental/relay-js)
- Demonstrates: Waku Relay, Pure Javascript/HTML using ESM/unpkg bundle.

### Waku Relay in ReactJS

A barebone chat app to illustrate the seamless integration of `js-waku` into ReactJS.

- [code](examples/relay-reactjs-chat)
- [website](https://lab.waku.org/relay-reactjs-chat)
- Demonstrates: Group chat, React/JavaScript, Waku Relay, Protobuf using `protobufjs`.

### Noise JS

- [code](examples/noise-js)
- [website](https://lab.waku.org/noise-js)
- [code](examples/experimental/noise-js)
- [website](https://lab.waku.org/experimental/noise-js)
- Demonstrates: LightPush, Filter, [Noise encryption](https://rfc.vac.dev/spec/35/).

### Noise RTC

- [code](examples/noise-rtc)
- [website](https://lab.waku.org/noise-rtc)
- [code](examples/experimental/noise-rtc)
- [website](https://lab.waku.org/experimental/noise-rtc)
- Demonstrates: LightPush, Filter, [Noise encryption](https://rfc.vac.dev/spec/35/), WebRTC.

### Relay Direct RTC

- [code](examples/relay-direct-rtc)
- [website](https://lab.waku.org/relay-direct-rtc)
- [code](examples/experimental/relay-direct-rtc)
- [website](https://lab.waku.org/experimental/relay-direct-rtc)
- Demonstrates: Relay over WebRTC.


Expand Down
19 changes: 9 additions & 10 deletions ci/Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,20 @@ pipeline {

stage('Examples') {
parallel {
stage('relay-angular-chat') { steps { script { buildExample() } } }
stage('relay-reactjs-chat') { steps { script { buildExample() } } }
stage('web-chat') { steps { script { buildExample() } } }
stage('noise-js') { steps { script { buildExample() } } }
stage('noise-rtc') { steps { script { buildExample() } } }
stage('relay-direct-rtc') { steps { script { buildExample() } } }
stage('rln-js') { steps { script { buildExample() } } }
stage('rln-identity') { steps { script { buildExample() } } }
stage('experimental/web-chat') { steps { script { buildExample() } } }
stage('experimental/noise-js') { steps { script { buildExample() } } }
stage('experimental/noise-rtc') { steps { script { buildExample() } } }
stage('experimental/relay-direct-rtc') { steps { script { buildExample() } } }
stage('experimental/rln-js') { steps { script { buildExample() } } }
stage('experimental/rln-identity') { steps { script { buildExample() } } }
stage('flush-notes') { steps { script { buildExample() } } }
}
}

stage('HTML Examples') {
parallel {
stage('relay-js') { steps { script { copyExample() } } }
stage('light-js') { steps { script { copyExample() } } }
stage('experimental/relay-js') { steps { script { copyExample() } } }
stage('experimental/light-js') { steps { script { copyExample() } } }
}
}

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 172d2f5

Please sign in to comment.