logos-messaging/docs.waku.org
1
0
Fork 0
mirror of https://github.com/logos-messaging/docs.waku.org.git synced 2026-01-07 07:13:12 +00:00
Code Issues Packages Projects Releases Wiki Activity
docs.waku.org/docs/guides/js-waku/waku-create-app.md
LordGhostX 301a4d8d22
JS-Waku docs (#82) 
* add js-waku outline

* add js-waku quickstart

* add waku-create-app guide

* add lightpush filter guide

* add complete relay guide

* initial feedback + add emitSelf

* add store guide outline

* add store query options

* update code snippets
2023-07-11 18:52:38 +01:00

1.7 KiB
Raw Blame History

title
Bootstrap DApps Using @waku/create-app

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

Usage

Initialize a new js-waku template using any of the following methods:

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

npx @waku/create-app [PROJECT DIRECTORY]

npm init @waku/app [PROJECT DIRECTORY]

yarn create @waku/app [PROJECT DIRECTORY]

Next, select a template to initialize 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 your submission and merge it upon approval.