Skip to content

Commit

Permalink
7.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins committed Mar 1, 2024
1 parent a451e97 commit 07c6ac3
Show file tree
Hide file tree
Showing 26 changed files with 7,890 additions and 6,332 deletions.
50 changes: 10 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,19 @@
# Regula Document Reader (Cordova)
# Regula Document Reader SDK for Cordova

Regula Document Reader SDK allows you to read various kinds of identification documents, passports, driving licenses, ID cards, etc. All processing is performed completely _**offline**_ on your device. No any data leaving your device.

You can use native camera to scan the documents or image from gallery for extract all data from it.

This repository contains the source code of the Document Reader API, and the sample application that demonstrates the _**API**_ calls you can use to interact with the Document Reader library.

# Contents
* [How to build demo application](#how-to-build-demo-application)
* [Troubleshooting license issues](#troubleshooting-license-issues)
* [Documentation](#documentation)
* [Additional information](#additional-information)

## How to build the demo application
1. Visit [client.regulaforensics.com](https://client.regulaforensics.com) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
2. Download or clone current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Cordova-Plugin.git`.
3. Run the following commands in Terminal:
```bash
$ cd example
$ npm install
$ npx jetify
$ cordova prepare
```

4. Copy the `regula.license` file to the `example/www` folder.
6. Android:
* Run `cordova run android` inside `example` folder - this is just one way to run the app. You can also run it directly from within Android Studio.

**Note**: if the gallery doesn't open, check if the following line is presented in the AndroidManifest.xml inside the `application` tag:
`<activity android:label="@string/multi_app_name" android:name="com.synconset.MultiImageChooserActivity" android:theme="@android:style/Theme.Holo.Light" />`

7. iOS:
* Run `cordova run ios` inside `example` folder - this is just one way to run the app. You can also run it directly from within Xcode.

### Troubleshooting license issues
If you have issues with license verification when running the application, please verify that next is true:
1. The OS, which you use, is specified in the license (e.g., Android and/or iOS).
3. The license is valid (not expired).
4. The date and time on the device, where you run the application, are valid.
5. You use the latest release version of the Document Reader SDK.
6. You placed the `license` into the correct folder as described [here](#how-to-build-demo-application).

## Documentation
You can find documentation on API [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/cordova).

## Additional information
If you have any technical questions, feel free to [contact](mailto:[email protected]) us or create issue [here](https://github.com/regulaforensics/DocumentReader-Cordova-Plugin/issues).
You can find documentation [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/cordova).

## License

To obtaining the production license or other purchasing information, please [submit an inquiry](https://regulaforensics.com/talk-to-an-expert) and our sales team will contact you shortly.

## Support

To use our SDK in your own app you need to [purchase](https://pipedrivewebforms.com/form/394a3706041290a04fbd0d18e7d7810f1841159) a commercial license.
Please do not hesitate to [contact us](https://support.regulaforensics.com/hc/requests/new), if you need any assistance or want to report a bug / suggest an improvement.
32 changes: 32 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# How to build the demo application

1. Get the trial license at [client.regulaforensics.com](https://client.regulaforensics.com/) (`regula.license` file). The license creation wizard will guide you through the necessary steps.
2. Get the trial database at [client.regulaforensics.com/customer/databases](https://client.regulaforensics.com/customer/databases) (`db.dat`)
3. Download or clone current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Cordova-Plugin.git`.
4. Copy the `regula.license` file to the `example/www/` folder.
5. Copy the `db.dat` file to the `example/www/` folder.
6. Run the following commands in Terminal:
```bash
$ cd example
$ npm install
$ npx jetify
$ cordova prepare
```

7. Android:
* Run `cordova run android` inside `example` folder - this is just one way to run the app. You can also run it directly from within Android Studio.

**Note**: if the gallery doesn't open, check if the following line is presented in the AndroidManifest.xml inside the `application` tag:
`<activity android:label="@string/multi_app_name" android:name="com.synconset.MultiImageChooserActivity" android:theme="@android:style/Theme.Holo.Light" />`

8. iOS:
* Run `cordova run ios` inside `example` folder - this is just one way to run the app. You can also run it directly from within Xcode.

# Troubleshooting license issues

If you have issues with license verification when running the application, please verify that next is true:
1. The OS, which you use, is specified in the license (e.g., Android and/or iOS).
3. The license is valid (not expired).
4. The date and time on the device, where you run the application, are valid.
5. You use the latest release version of the Document Reader SDK.
6. You placed the `license` into the correct folder as described [here](#how-to-build-demo-application).
6 changes: 5 additions & 1 deletion example/config.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
<allow-intent href="mailto:*" />
<allow-intent href="geo:*" />
<platform name="android">
<resource-file src="www/db.dat" target="app/src/main/assets/Regula/db.dat"/>
<preference name="android-minSdkVersion" value="23" />
<preference name="android-targetSdkVersion" value="34" />
<allow-intent href="market:*" />
Expand All @@ -27,12 +28,15 @@
</config-file>
</platform>
<platform name="ios">
<resource-file src="www/db.dat" />
<allow-intent href="itms:*" />
<allow-intent href="itms-apps:*" />
<preference name="CAMERA_USAGE_DESCRIPTION" default=" " />
<config-file target="*-Info.plist" parent="NSCameraUsageDescription">
<string>To use camera</string>
</config-file>
<config-file target="*-Info.plist" parent="NSPhotoLibraryUsageDescription">
<string>To pick images</string>
</config-file>
<config-file target="*-Info.plist" parent="NFCReaderUsageDescription">
<string>To use NFC</string>
</config-file>
Expand Down
17 changes: 7 additions & 10 deletions example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,22 @@
"author": "Regula Forensics Inc.",
"license": "commercial",
"dependencies": {
"@regulaforensics/cordova-plugin-document-reader-api": "6.9.1",
"@regulaforensics/cordova-plugin-document-reader-core-fullrfid": "6.9.0",
"cordova-android": "12.0.0",
"cordova-ios": "7.0.0",
"@regulaforensics/cordova-plugin-document-reader-api": "7.1.0",
"@regulaforensics/cordova-plugin-document-reader-core-fullrfid": "7.1.0",
"cordova-android": "12.0.1",
"cordova-ios": "7.0.1",
"cordova-plugin-add-swift-support": "2.0.2",
"cordova-plugin-advanced-http": "3.3.1",
"cordova-plugin-android-permissions": "1.1.5",
"cordova-plugin-camera": "7.0.0",
"cordova-plugin-file": "8.0.0",
"jetifier": "2.0.0"
},
"cordova": {
"plugins": {
"@regulaforensics/cordova-plugin-document-reader-api": {
"CAMERA_USAGE_DESCRIPTION": "To take photo",
"READ_EXTERNAL_STORAGE": "To choose photo"
},
"@regulaforensics/cordova-plugin-document-reader-api": {},
"@regulaforensics/cordova-plugin-document-reader-core-fullrfid": {},
"cordova-plugin-file": {},
"cordova-plugin-android-permissions": {},
"cordova-plugin-camera": {},
"cordova-plugin-advanced-http": {}
},
"platforms": [
Expand Down
Loading

0 comments on commit 07c6ac3

Please sign in to comment.