Skip to Content
API ReferenceAvail Nexus SDK API

Avail Nexus

Prerequisites

BEFORE WE START

  1. The Nexus SDK requires an injected wallet provider (e.g. MetaMask, WalletConnect, etc.)
  2. It is designed for client-side browser environments and cannot be used in any server-side environments.
  3. You will need a React-based dev environment to use the SDK UI components.
  4. GitHub: availproject/nexus-sdk
  5. npm.js Package: @avail-project/nexus

Dev Environment Setup

Use React Frontend

Set up a React Frontend Project.

Any React-based dev environment works, including React frameworks like Next.js, Remix, Gatsby, or build tools like Vite, Create React App, and Webpack.

Install SDK

Install the Nexus SDK.

Use any package manager of your choice to install the Nexus SDK:

Terminal
npm install @avail-project/nexus

We built a React demo app that uses the Avail Nexus SDK UI components to implement a unified Web3 experience.

  1. You can use the app here: nexus-ui-components-demo.vercel.app
  2. You can find the code for the app here: availproject/nexus-ui-components-demo
Last updated on