Skip to content

Latest commit

 

History

History
88 lines (68 loc) · 4.6 KB

README.md

File metadata and controls

88 lines (68 loc) · 4.6 KB
Raw

License: MIT

Veryfi Lens React Native

Veryfi Lens is code (a framework) with UI for your mobile app to give it document capture superpowers in minutes.

Let Veryfi handle the complexities of frame processing, asset preprocessing, edge routing, and machine vision challenges in document capture. We have been at this for a long time and understand the intricate nature of mobile capture. That’s why we built Lens. Veryfi Lens is built by developers for developers; making the whole process of integrating Lens into your app fast and easy with as few lines as possible.

Veryfi Lens is a Framework: a self-contained, reusable chunks of code and resources you can import into you app.

Lens is built in native code and optimized for fast performance, clean user experience and low memory usage.

You can read further about Lens in Veryfi's dedicated page: https://www.veryfi.com/lens/

You can watch our video: Veryfi Lens

Table of content

  1. Configuration
  2. iOS Localization
  3. Other platforms
  4. Get in contact with our team

Configuration

  • Go to Lens: Maven (Android) section and generate your access credentials here.
  • Add your Maven credentials to your system environment. Replace [USERNAME] and [PASSWORD] with the credentials that were set up in the previous step.
export MAVEN_VERYFI_USERNAME=[USERNAME]
export MAVEN_VERYFI_PASSWORD=[PASSWORD]

Min SDK Android 6.0 (API level 23)

Min iOS version 12

  • Clone this repository
  • Go to Lens: React Native (iOS + Android) section and generate your access credentials here.
  • Run npm config set @veryfi:registry https://nexus.veryfi.com/repository/npm/
  • Run echo "//nexus.veryfi.com/repository/:username=[USERNAME]" >> ~/.npmrc
  • Run echo "//nexus.veryfi.com/repository/:_password=$(echo -n [PASSWORD] | base64)" >> ~/.npmrc
  • Run npm i @veryfi/react-native-veryfi-lens
  • Replace [USERNAME] and [PASSWORD] with the credentials that were set up in the previous step.

Using yarn 3

yarn config set npmScopes.veryfi.npmRegistryServer "https://nexus.veryfi.com/repository/npm/"
yarn config set npmScopes.veryfi.npmAlwaysAuth true
yarn config set npmScopes.veryfi.npmAuthIdent $(echo -n '[NPM_USERNAME]:[NPM_PASSWORD]' | openssl base64 -A)
  • Replace credentials in App.tsx with yours
const veryfiLensCredentials = {
  url: 'yourUrl',
  clientId: 'yourClientId',
  userName: 'yourUsername',
  apiKey: 'yourApiKey',
};
  • Run pod install on the iOS folder.
  • Start metro running npx react-native start.
  • Run your desired platform using: npx react-native run-android or npx react-native run-ios

iOS Localization (Optional)

  • In order to be able to enable iOS Lens native localization you need to enable a supported language on the project file: Step 1

  • Generate localization files for the desired language (for example in storyboard): Step 2

  • At the end you should have at least 1 file localized for each language that you want to enable localization, see example: Step 3

Other platforms

We also support the following wrappers for native and hybrid frameworks:

If you don't have access to our Hub, please contact our sales team, you can find the contact bellow.

Get in contact with our sales team

Contact [email protected] to learn more about Veryfi's awesome products.