CONTRIBUTING.md

Contributing to Waku

Prerequisites

• Node.js: see specific version in package.json

corepack enable
pnpm install

Building

Before you start, make sure to build Waku so that the examples can be run.

pnpm run compile

Start with example

pnpm -F 01_template dev # to run examples/01_template in dev mode

build and start can be run with the same pattern:

pnpm -F 01_template build
pnpm -F 01_template start

More examples can be found in the examples directory.

Testing

We are using playwright for end-to-end testing.

pnpm run e2e

Trying an experimental version

To try an app with an experimental version of Waku, change the waku dependency in the app's package.json to "github:<REPO_OWNER>/waku#<GIT_REF>&path:/packages/waku" and run pnpm install. For example:

{
  "dependencies": {
    "waku": "github:your_username/waku#your_branch&path:/packages/waku"
  }
}