docs.waku.org/docs/guides/getting-started.md

49 lines
3.2 KiB
Markdown
Raw Normal View History

2023-05-23 11:50:55 +00:00
---
2023-11-23 11:01:32 +00:00
title: Getting Started
hide_table_of_contents: true
slug: /
2023-05-23 11:50:55 +00:00
---
:::caution
2023-11-23 11:01:32 +00:00
Waku has risks and limitations as it is still developing and preparing for extensive adoption. However, it is already demonstrating its capabilities by powering various applications. [Join our community](https://waku.org/community/) to stay updated on our progress.
2023-05-23 11:50:55 +00:00
:::
2023-06-19 17:07:45 +00:00
Ready to integrate Waku into your application for private, secure, censorship-free communication? Explore the available SDKs and contribute by running a node.
2023-05-23 11:50:55 +00:00
2023-11-23 11:01:32 +00:00
## Run a Waku node
2023-05-23 11:50:55 +00:00
The Waku Network is a decentralised, permissionless system where anyone can run nodes, use the network, and contribute to its support.
2023-06-08 12:28:25 +00:00
2023-06-09 19:32:04 +00:00
| | Description | Documentation |
2023-06-08 12:28:25 +00:00
| - | - | - |
2023-11-23 11:01:32 +00:00
| [nwaku](https://github.com/waku-org/nwaku) | Nim-based Waku implementation to run a standalone node and access the network (recommended) | [Run a Nwaku Node](/guides/nwaku/run-node) |
| [nwaku-compose](https://github.com/waku-org/nwaku-compose) | Pre-configured Docker Compose setup for running a RLN-enabled `nwaku` node with Grafana metrics dashboard | [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) |
2023-07-15 23:08:27 +00:00
| [go-waku](https://github.com/waku-org/go-waku) | Golang-based Waku implementation to run a standalone node and access the network | COMING SOON |
2023-05-23 11:50:55 +00:00
2023-11-23 11:01:32 +00:00
## Integrate using SDKs
2023-05-27 06:45:58 +00:00
2023-06-09 19:32:04 +00:00
Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently.
2023-05-23 11:50:55 +00:00
2023-06-09 19:32:04 +00:00
| | Description | Documentation |
2023-05-23 11:50:55 +00:00
| - | - | - |
| [@waku/sdk](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | [JavaScript Waku SDK](/guides/js-waku/) |
| [@waku/react](https://www.npmjs.com/package/@waku/react) | React components and UI adapters designed for seamless integration with `@waku/sdk` | [Build React DApps Using @waku/react](/guides/js-waku/use-waku-react) |
2023-07-15 23:08:27 +00:00
| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK designed for integration with native Nim applications | COMING SOON |
| [go-waku](https://github.com/waku-org/go-waku) | Golang SDK designed for integration with Golang applications, includes C bindings for usage in C/C++, C#/Unity, Swift, and Kotlin | COMING SOON |
| [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) | Rust wrapper using `go-waku` bindings designed for integration in Rust applications | COMING SOON |
2023-05-23 11:50:55 +00:00
2023-11-23 11:01:32 +00:00
## Run on mobile devices
2023-05-23 11:50:55 +00:00
2023-06-09 19:32:04 +00:00
Waku provides integrations tailored for mobile applications, enabling Waku to run efficiently on mobile devices.
2023-05-27 06:45:58 +00:00
2023-06-09 19:32:04 +00:00
| | Description | Documentation |
2023-05-23 11:50:55 +00:00
| - | - | - |
2023-07-15 23:08:27 +00:00
| Swift (iOS) | `go-waku` bindings for Swift applications to seamlessly integrate Waku | COMING SOON |
| Kotlin (Android) | `go-waku` bindings for Kotlin applications to seamlessly integrate Waku | COMING SOON |
2023-11-23 11:01:32 +00:00
## More integrations
2023-06-09 19:32:04 +00:00
| | Description | Documentation |
| - | - | - |
2023-11-30 17:42:27 +00:00
| [REST API](https://waku-org.github.io/waku-rest-api/) | REST API interface provided by `nwaku` and `go-waku` to interact with the Waku Network | [Waku Node REST API Reference](https://waku-org.github.io/waku-rest-api/) |
| [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next `@waku/sdk` project from various example templates | [Scaffold DApps Using @waku/create-app](/guides/js-waku/use-waku-create-app) |