waku-org
/
docs.waku.org
mirror of https://github.com/waku-org/docs.waku.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docs.waku.org/docs/guides/js-waku/use-waku-create-app.md

1.8 KiB
Raw Blame History

title
Scaffold DApps Using @waku/create-app

This guide provides detailed steps to bootstrap your next @waku/sdk project from various example templates using the @waku/create-app package.

Usage

Initialise a new @waku/sdk template using any of the following methods:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

npx @waku/create-app [PROJECT DIRECTORY]

yarn create @waku/app [PROJECT DIRECTORY]

Next, select a template to initialise your app from:

waku create app demo

:::tip If you have previously installed @waku/create-app globally, we recommend uninstalling the package to ensure that npx always uses the latest version. :::

Contributing New Templates

We welcome and appreciate the contributions of templates for the @waku/create-app package. To contribute a template, please follow these steps:

  1. Create the template, ensuring it is user-friendly and thoroughly tested.
  2. Place the template in the examples folder in the js-waku-examples repository's root.
  3. Commit your changes with a detailed message and push them to your forked repository.
  4. Finally, submit a pull request to the js-waku-examples repository.
  5. Our team will carefully review and merge your submission upon approval.

Waku also provides bounties to encourage community members to contribute to the network and earn rewards. To participate in the bounty program, head to https://github.com/waku-org/bounties.