js-waku/examples/web-chat
Franck Royer 2306bb1708
Add breakdown of what examples demonstrate
Also move explanation to each readme.
2021-08-02 10:45:10 +10:00
..
public Revert naming to js-waku 2021-05-13 20:27:38 +10:00
src Simplify message handling to avoid re-rendering 2021-07-29 17:23:03 +10:00
.gitignore Move web-chat to examples folder 2021-05-05 16:35:14 +10:00
.prettierignore Move web-chat to examples folder 2021-05-05 16:35:14 +10:00
README.md Add breakdown of what examples demonstrate 2021-08-02 10:45:10 +10:00
package-lock.json Revert naming to js-waku 2021-05-13 20:27:38 +10:00
package.json Revert naming to js-waku 2021-05-13 20:27:38 +10:00
tsconfig.json Move web-chat to examples folder 2021-05-05 16:35:14 +10:00

README.md

Web Chat App

Demonstrates:

  • Group chat
  • React/TypeScript
  • Waku Relay
  • Waku Store

A ReactJS chat app is provided as a showcase of the library used in the browser. It implements Waku v2 Toy Chat protocol. A deployed version is available at https://status-im.github.io/js-waku/.

To run a development version locally, do:

git clone https://github.com/status-im/js-waku/ ; cd js-waku
npm install   # Install dependencies for js-waku
npm run build # Build js-waku
cd examples/web-chat   
npm install   # Install dependencies for the web app
npm run start # Start development server to serve the web app on http://localhost:3000/js-waku

Use /help to see the available commands.