gem-hunter
Language: TypeScript
ReactNative on-device face verification, liveness detection, and face enrollment for Android and iOS.
Offline enrollment · 1:1 verification · Liveness detection · Feature management
English · 简体中文
Quick start · Integration & API · Demo source
SDK 1.8.0 React Native 0.84.0
The main branch demonstrates the published
@faceaisdk/react-native-face-sdk package.
Physical devices required: iOS 15.5+ or Android API 24+. Simulators are not supported.
npm ci npm run doctor
doctor checks dependency versions and the local toolchain. To check one platform,
use npm run doctor -- --android or npm run doctor -- --ios.
Connect and unlock the phone, enable USB debugging, and accept the computer's authorization prompt.
# Terminal 1 — keep Metro running on port 8765
npm start# Terminal 2 — install and run on the device
npm run androidcd ios && pod install --deployment && cd ..
Open ios/FaceAISDK_RN.xcworkspace, select your own Development Team,
and connect an unlocked iPhone.
npm run ios
The shared scheme runs Release by default, with JavaScript bundled.
For Debug, start Metro with npm start, then use npm run ios -- --mode Debug.
Use the legacy installer:
npm run ios:legacy
It installs Release; tap the app icon to launch. The build log is saved to
ios/build/ios-legacy.log.
Node.js 22.11+ is required. Install Android components in SDK Manager and
configure ANDROID_HOME or android/local.properties.
| Component | Verified version |
|---|---|
| Node.js / npm | 26.0.0 / 11.12.1 |
| React Native / CLI | 0.84.0 / 20.2.0 |
| Xcode / Swift / CocoaPods | 26.6 (17F113) / 6.3.3 / 1.16.2 |
| JDK | 17 |
| Android SDK / Build Tools | 34 / 35.0.0 |
| Android NDK / CMake | 28.1.13356709 / 3.22.1 |
| Gradle wrapper | 8.14.3 (included in the project) |
| Native SDK — Android | 2026.10.29.meiju |
| Native SDK — iOS Core | 2026.10.29 |
The plugin version is pinned. Keep package-lock.json and ios/Podfile.lock
committed; upgrade the plugin, iOS Core tag, and both lockfiles together.
| Symptom | What to check |
|---|---|
| SDK unavailable | Install dependencies and Pods, then rebuild the native app. |
| Version conflict | Run npm run doctor; restore matching lockfiles before reinstalling. |
| No enrolled feature | Enroll a face and confirm saving before verification. |
| Debug page does not load | Check Metro and device access to port 8765. |
| iOS installation fails | Run from Xcode; use ios:legacy for iOS 16 and earlier. |
Report an issue · FaceAISDK.Service@gmail.com