Installation Guide

This page contains the installation guide needed for OkayID Lite in Android, iOS and React-native

Android Installation Guide

The first step of the installation for OkayID Lite in Android is to include the following dependencies in the project-level build.gradle file. The build.gradle file will need to make some changes as follow below:

allprojects {
    repositories {
        ...
        mavenCentral()
    }
}

Include the following dependencies in the app-level build.gradle file as shown below:

dependencies {
    implementation 'com.innov8tif.okayidlite:OkayIDLite:1.0.2'
}

After adding the code, sync the project with gradle files to make sure all of the dependencies is successfully installed.

iOS Installation Guide

OkayID Lite is available through the CocoaPods. The first step of the installation for OkayID Lite in iOS is to simply add the following line of code to your app target as shown below:

use_frameworks!
pod 'OkayIDLite', '1.0.10'

post_install do |installer|
    installer.pods_project.targets.each do |target|
        if target.name == "CryptoSwift"
            puts "Enable module stability for CryptoSwift"
            target.build_configurations.each do |config|
                config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
            end
        end
    end
end

After adding the code above to the Podfiles:

Run the command "pod install" to install the dependency.
Add "NSCameraUsageDescription" to the info.plist in order to gain camera permissions

React-native Installation Guide

In React-native, the first step of the installation is to install the react-native OkayIDLite into the environment using the command below:

$ react-native install react-native-okayid-lite

For iOS in React-native:

Navigate to the iOS folder and add the following code to the Podfiles:

platform :ios, '11.0'
use_frameworks!

post_install do |installer|
    installer.pods_project.targets.each do |target|
        if target.name == "CryptoSwift"
			        puts "Enable module stability for CryptoSwift"
			        target.build_configurations.each do |config|
				            config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES' 
				    end
        end
    end
end

After adding the code above to the Podfiles:

Run the command "pod install" to install the dependency
Add "NSCameraUsageDescription" to the info.plist in order to gain camera permissions
Add ${PODS_ROOT}/GoogleMLKit/MLKitCore/Sources to Pod Project Header Search Path

Add "NSCameraUsageDescription" to the info.plist in order to gain camera permissions

Issues

iOS:

There will be several issues stated in the quote below:

Undefined symbol: _swift_FORCE_LOAD$_swiftUniformTypeIdentifiers
Undefined symbol: _swift_FORCE_LOAD$_swiftCoreMIDI

If users encountered the errors above, it can be solved by creating a new swift file called Void.swift without adding a bridging header.

License

After that, a license key is required for both Android and iOS by adding the code below:

const license = Platform.select({
    android: "",
    ios: ""
})

Please be aware of the codes and commands above are case sensitive

PreviousGetting Started with OkayID Lite NextDevelopment

Last updated 4 years ago

Was this helpful?