Installation

Welcome to the first step in integrating Reclaim Protocol into your React Native Expo project! This guide will walk you through the installation process and help you get started quickly.

Prerequisites

Before starting, ensure you have the following requirements installed:

Node.js (version 16.0.0 or later)
npm (Node Package Manager, included with Node.js) or yarn
A working React Native Expo project
- If you haven't created one, run: npx create-expo-app@latest my-app

Make sure your Expo project is properly configured and can run successfully before installing the SDK.

Installation

1. Install the SDK

Navigate to your React Native Expo project's root directory and execute one of the following commands:

Using npm:

npm install @reclaimprotocol/reactnative-sdk

Using yarn:

yarn add @reclaimprotocol/reactnative-sdk

Using Expo CLI:

npx expo install @reclaimprotocol/reactnative-sdk

2. Expo Configuration

Since the Reclaim SDK uses native modules and deep linking, you need to configure your Expo project properly.

Update app.json/app.config.js

Add the following configuration to your app.json or app.config.js:

{
  "expo": {
    "name": "Your App Name",
    "slug": "your-app-slug",
    "version": "1.0.0",
    "orientation": "portrait",
    "icon": "./assets/icon.png",
    "userInterfaceStyle": "light",
    "splash": {
      "image": "./assets/splash.png",
      "resizeMode": "contain",
      "backgroundColor": "#ffffff"
    },
    "scheme": "your-app-scheme",
    "plugins": [
      "expo-router",
      "expo-splash-screen",
      "expo-web-browser"
    ],
    "assetBundlePatterns": [
      "**/*"
    ],
    "ios": {
      "supportsTablet": true,
      "bundleIdentifier": "com.yourcompany.yourapp"
    },
    "android": {
      "adaptiveIcon": {
        "foregroundImage": "./assets/adaptive-icon.png",
        "backgroundColor": "#FFFFFF"
      },
      "package": "com.yourcompany.yourapp",
      "intentFilters": [
        {
          "action": "VIEW",
          "autoVerify": true,
          "data": [
            {
              "scheme": "https",
              "host": "your-domain.com"
            }
          ],
          "category": ["BROWSABLE", "DEFAULT"]
        }
      ]
    },
    "web": {
      "favicon": "./assets/favicon.png"
    }
  }
}

Replace your-app-scheme, your-domain.com, and package identifiers with your actual values.

Next Steps

Now that you've installed the SDK successfully, you can:

Follow the Usage guide to create your first proof request
Explore Advance Options for customization

Troubleshooting

Common issues and solutions:

Metro bundler issues

# Clear Metro cache
npx expo start --clear

Native module issues

# Rebuild development build
eas build --profile development --platform all --clear-cache

Keep your SDK and Expo SDK versions up to date by regularly checking for updates using npx expo install --fix.

Installation

On this page