Skip to content

Latest commit

 

History

History
113 lines (70 loc) · 3.91 KB

README.md

File metadata and controls

113 lines (70 loc) · 3.91 KB
Raw

Hyperswitch Client Core

This repository hosts the essential components of the Hyperswitch SDK, which supports various platforms. Directly cloning this repository allows immediate access to a web-compatible version of the SDK.

Important: The official Hyperswitch Web SDK is maintained separately. Visit this link for details.

The hyperswitch-client-core is designed to function within a git submodule framework, facilitating integration with iOS, Android, React Native, Flutter, and Web platforms.

Setting up the SDK

For Android or iOS integration, initialize the necessary submodules using:

git submodule update --init --recursive

Installing Dependencies

To install required dependencies:

yarn install

Set Environment Variables

Rename .en file to .env and input your Hyperswitch API and Publishable Key. Get your Hyperswitch keys from Hyperswitch dashboard

Start the server

Launch two terminal instances to start the servers:

yarn run server     # This starts the mock server
yarn run re:start   # This initiates the Rescript compiler

Starting the Metro Server

To begin the metro server for native app development:

yarn run start

Launching the Playground

To run the playground, use the following commands based on the target platform:

Platform Command
Web yarn run web
Android yarn run android
iOS yarn run ios

Upon successful setup, your application should be operational on your Android Emulator or iOS Simulator, assuming the emulator or simulator is configured properly. Additionally, the application can be executed directly from Android Studio or Xcode.

Setup iOS local development

The following table outlines the available configuration variables, their values, and descriptions:

Key Value Description
HyperswitchSource LocalHosted Load the bundle from the Metro server
HyperswitchSource LocalBundle Load the bundle from a pre-compiled local bundle

HyperswitchSource defaults to LocalHosted.

Note: To run the SDK on a physical iOS device, ensure that your Mac and the iOS device are connected to the same Wi-Fi network. Additionally, you'll need to provide your Mac's IP address as the value for the HyperswitchSourceIP key, as shown in the following table:

Key Value
HyperswitchSourceIP 10.0.0.1

Replace 10.0.0.1 with your actual Mac's IP address.

How to set variables

During local development, you may need to set specific variables to configure the SDK's behavior. You can set these variables using Xcode, command line interface (CLI), or any text editor. All changes will be made inside ios folder(submodule).

Xcode

Project > Targets > Info Custom iOS Target Properties

CLI

Alternatively, you can leverage the plutil command to modify the Info.plist file directly from the terminal. For example, to set the HyperswitchSource variable, execute the following command:

plutil -replace HyperswitchSource -string "LocalBundle" Info.plist

Info.plist is present in hyperswitch directory.

Text Editor

If you prefer a more manual approach, you can open the Info.plist file in a text editor and add or modify the required keys and their corresponding values. For instance:

<key>HyperswitchSource</key>
<string>LocalHosted</string>
<key>HyperswitchSourceIP</key>
<string>10.0.0.1</string>

Integration

Get started with our 📚 integration guides

Licenses