Installation
Get started with the Refract SDK by installing the package and configuring your project.
Prerequisites
Before you begin, make sure you have the following installed in your development environment:
- Node.js (v18 or higher)
- A package manager like npm, yarn, or pnpm
- An existing dApp project (React, Vue, etc.)
Step 1: Get Your Application ID (appId
)
Every dApp on the Refract Network needs a unique appId
to interact with our services. You can get yours from the Refract Portal.
- Sign Up/Log In: Head to the Refract Portal and create an account or log in. ::TODO: Add correct URL
- Register Your dApp: Navigate to the dashboard and register a new application. You’ll be asked for basic information like your dApp’s name and the blockchain it runs on.
- Copy Your
appId
: Once registered, your uniqueappId
will be displayed on your project’s dashboard. Keep it handy; you’ll need it during setup.
What is the
appId
? TheappId
is a unique identifier that securely associates your dApp with the Refract Network. It ensures that all transaction requests and API calls are correctly attributed to your project, enabling features like analytics, quest tracking, and GasMaster sponsorship.
Step 2: Install the SDK Package
Once you have your appId
, install the core Refract bridge package into your project using your preferred package manager.
That’s it! The SDK is now installed. The next step is to configure it within your application.