Installation

Introduction

AppKit has support for Wagmi and Ethers v6 on Ethereum, @solana/web3.js on Solana and Bitcoin. Choose one of these to get started.

Installation

Setting up from scratch? → Try out the AppKit CLI templates or the AI-assisted setup.

Custom Installation

Wagmi

npm

npm install @reown/appkit @reown/appkit-adapter-wagmi @tanstack/vue-query @wagmi/vue viem

Don’t have a project ID?

Head over to Reown Dashboard and create a new project now!

Get started

Cloud Configuration

Create a new project on Reown Dashboard at https://dashboard.reown.com and obtain a new project ID.

Implementation

Wagmi

wagmi Example

Check the Vue wagmi example

For a quick integration, you can use the createAppKit function with a unified configuration. This automatically applies the predefined configurations for different adapters like Wagmi, Ethers, or Solana, so you no longer need to manually configure each one individually. Simply pass the common parameters such as projectId, chains, metadata, etc., and the function will handle the adapter-specific configurations under the hood.

This includes WalletConnect, Coinbase and Injected connectors, and the Blockchain API as a transport

If you’re using Nuxt, you can set wagmi’s ssr option to true and call the reconnect function after your application mounts.

In your App.vue file set up the following configuration

<script lang="ts" setup>
  import { createAppKit } from '@reown/appkit/vue'
  import { arbitrum, mainnet, type AppKitNetwork } from '@reown/appkit/networks'
  import { WagmiAdapter } from '@reown/appkit-adapter-wagmi'

  // 1. Get projectId from https://dashboard.reown.com
  const projectId = 'YOUR_PROJECT_ID'

  // 2. Create a metadata object
  const metadata = {
    name: 'AppKit',
    description: 'AppKit Example',
    url: 'https://example.com', // origin must match your domain & subdomain
    icons: ['https://avatars.githubusercontent.com/u/179229932']
  }

  // 3. Set the networks
  const networks: [AppKitNetwork, ...AppKitNetwork[]] = [mainnet, polygon, base]

  // 4. Create Wagmi Adapter
  const wagmiAdapter = new WagmiAdapter({
    networks,
    projectId
  })

  // 5. Create the modal
  const modal = createAppKit({
    adapters: [wagmiAdapter],
    networks,
    projectId,
    metadata,
    features: {
      analytics: true // Optional - defaults to your Cloud configuration
    }
  })
</script>

<template> // Rest of your app ... </template>

Importing networks

Reown AppKit use Viem networks under the hood, which provide a wide variety of networks for EVM chains. You can find all the networks supported by Viem within the @reown/appkit/networks path.

import { createAppKit } from '@reown/appkit/vue'
import { mainnet, arbitrum, base, scroll, polygon } from '@reown/appkit/networks'

Looking to add a custom network? Check out the custom networks section.

Trigger the modal

Wagmi

To open AppKit you can use our web component or build your own button with AppKit composables. In this example we are going to use the <appkit-button> component.

Web components are global html elements that don’t require importing.

<template>
  <appkit-button />
</template>

Learn more about the AppKit web components here

Smart Contract Interaction

Wagmi

Wagmi actions can help us interact with wallets and smart contracts:

<script setup lang="ts">
  import { readContract } from "@wagmi/core";
  import { USDTAbi } from "../abi/USDTAbi";

  const USDTAddress = "0x...";

  const data = readContract({
    abi: USDTAbi,
    address: USDTAddress,
    functionName: "symbol",
  });
</script>

Read more about Wagmi actions for smart contract interaction here.

Alternative Installation

If you are starting from scratch, you can use the following methods to set up your project with Reown AppKit.

Set up Reown AppKit using AI

If you’re using Cursor IDE (or another AI based IDE) to build a project with Reown AppKit, Reown provides a .mdc file that enhances your development experience. The reown-appkit.mdc file here contains Cursor-specific rules and type hints for Reown AppKit.

To use it in your project:

1. Copy the reown-appkit.mdc file from this repository
2. Create a .cursor/rules folder in your project’s root directory (if it doesn’t exist)
3. Place the .mdc file in your project’s .cursor/rules folder

For more info, refer to Cursor’s documentation.

AppKit CLI

Reown offers a dedicated CLI to set up a minimal version of AppKit in the easiest and quickest way possible.

To do this, please run the command below.

npx @reown/appkit-cli

After running the command, you will be prompted to confirm the installation of the CLI. Upon your confirmation, the CLI will request the following details:

1. Project Name: Enter the name for your project.
2. Framework: Select your preferred framework or library. Currently, you have three options: React, Next.js, and Vue.
3. Network-Specific libraries: Choose whether you want to install Wagmi, Ethers, Solana, or Multichain (EVM + Solana).

After providing the project name and selecting your preferences, the CLI will install a minimal example of AppKit with your preferred blockchain library. The example will be pre-configured with a projectId that will only work on localhost.

To fully configure your project, please obtain a projectId from the Reown Dashboard and update your project accordingly.

Refer to this section for more information.