Skip to content

Installation

How to install Document Reader SDK.

Overview

graph LR
  A(Document Reader SDK) --> B(API);
  A --> C(Core);
  B --> D(Common);
  A -.- E[(Database)];

Document Reader SDK consists of two frameworks: API and Core.

API framework provides the external interface for controlling the process and getting the result. It depens on the Common framework that is an interface for working with the camera and other modules that are used in other Regula SDKs.

Core framework provides the recognition functionality where all the processing happens. This is the internal framework, it is used by the API framework only and is not accessible for developers. However, it should be referenced in the project.

Database contains the documents' data. It's mandatory to have it if you use the Core type that supports document type recognition.

Requirements

Installation

npm

To the latest release version, run the following commands in Terminal:

npm i @regulaforensics/react-native-document-reader-api
npm i @regulaforensics/react-native-document-reader-core-fullrfid

Alternatively, you can indicate a specific version (e.g. 1.0.0):

npm i @regulaforensics/react-native-document-reader-api@1.0.0
npm i @regulaforensics/react-native-document-reader-core-fullrfid@1.0.0

Now, you can import the SDK in your code.

Yarn

To the latest release version, run the following commands in Terminal:

yarn add @regulaforensics/react-native-document-reader-api
yarn add @regulaforensics/react-native-document-reader-core-fullrfid

Alternatively, you can indicate a specific version(e.g. 1.0.0):

yarn add @regulaforensics/react-native-document-reader-api@1.0.0
yarn add @regulaforensics/react-native-document-reader-core-fullrfid@1.0.0

Now, you can import the SDK in your code.

Next Steps