301a4d8d22
* 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
2.7 KiB
| title |
|---|
| JavaScript Waku SDK |
The JavaScript Waku SDK (js-waku) provides a TypeScript implementation of the Waku protocol designed for web browser environments. Developers can seamlessly integrate Waku functionalities into web applications, enabling efficient communication and collaboration among users using the js-waku SDK.
Installation
Install the js-waku SDK using your preferred package manager:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
npm install @waku/sdk
yarn add @waku/sdk
You can also use the js-waku SDK via a CDN without installing it on your system:
import * as waku from "https://unpkg.com/@waku/sdk@latest/bundle/index.js";
Getting Started
Check out the quick start guide and comprehensive tutorials to learn how to build applications with js-waku.
| Guide | Description |
|---|---|
| Quick Start | Quickly familiarize yourself with js-waku by setting up a Waku node and sending messages using the Relay protocol |
| Send and Receive Messages Using Relay | Learn how to set up a Waku node for sending and receiving messages using the Relay protocol |
| Send and Receive Messages Using Light Push and Filter | Learn how to send and receive messages on light nodes using the Light Push and Filter protocols |
| Retrieve Messages Using Store | Learn how to retrieve and filter historical messages on light nodes using the Store protocol |
| Bootstrap DApps Using @waku/create-app | Learn how to use the @waku/create-app package to bootstrap your next js-waku project from various example templates |
Get Help and Report Issues
To engage in general discussions, seek assistance, or stay updated with the latest news, visit the #support and #js-waku-contribute channels on the Waku Discord.
If you discover bugs or want to suggest new features, do not hesitate to open an issue in the js-waku repository. Your feedback and contributions are highly valued and will help improve the js-waku SDK.