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 8238ba8 commit 96bf584
Show file tree
Hide file tree
Showing 86 changed files with 2,240 additions and 2,144 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# Regula Document Reader (Ionic)
# Regula Document Reader SDK for Ionic

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
* [Documentation](#documentation)
* [Additional information](#additional-information)

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

## 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-Ionic-Plugin/issues).
You can find documentation [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/ionic).

## 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.
14 changes: 8 additions & 6 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
# How to build demo application
1. Visit [licensing.regulaforensics.com](https://licensing.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 this repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Ionic-Plugin.git`.
3. Run the following commands in Terminal:
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 this repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Ionic-Plugin.git`.
4. Copy the `regula.license` file to the `example/src/assets/` folder.
5. Copy the `db.dat` file to the `example/src/assets/` folder.
6. Run the following commands in Terminal:
```bash
$ cd example
$ npm install
$ npx jetify
$ ionic cordova prepare
```
4. Copy the `regula.license` file to the `example/src/assets` folder.

5. Android:
7. Android:
* Run `ionic cordova build android`, then`ionic 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.

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


Expand Down
13 changes: 5 additions & 8 deletions example/config.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,17 @@
<preference name="SplashScreen" value="screen" />
<preference name="SplashScreenDelay" value="3000" />
<platform name="android">
<resource-file src="src/assets/db.dat" target="app/src/main/assets/Regula/db.dat"/>
<framework src="com.android.support:appcompat-v7:+" />
<config-file parent="/*" target="AndroidManifest.xml">
<uses-permission android:name="android.permission.NFC" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
<uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
</config-file>
<config-file parent="/manifest/application" target="AndroidManifest.xml">
<activity android:label="@string/multi_app_name" android:name="com.synconset.MultiImageChooserActivity" android:theme="@style/Theme.AppCompat.Light" />
</config-file>

<preference name="android-minSdkVersion" value="21" />
<preference name="android-targetSdkVersion" value="33" />
<preference name="AndroidXEnabled" value="true" />
<preference name="GradlePluginKotlinEnabled" value="true" />
<preference name="GradlePluginKotlinCodeStyle" value="official" />
<preference name="GradlePluginKotlinVersion" value="1.7.10" />

<resource-file src="resources/android/xml/network_security_config.xml" target="app/src/main/res/xml/network_security_config.xml" />
<allow-intent href="market:*" />
Expand All @@ -58,12 +53,15 @@
<splash density="port-xxxhdpi" src="resources/android/splash/drawable-port-xxxhdpi-screen.png" />
</platform>
<platform name="ios">
<resource-file src="src/assets/db.dat" />
<allow-intent href="itms:*" />
<allow-intent href="itms-apps:*" />
<preference default=" " name="CAMERA_USAGE_DESCRIPTION" />
<config-file parent="NSCameraUsageDescription" target="*-Info.plist">
<string>To use camera</string>
</config-file>
<config-file parent="NSPhotoLibraryUsageDescription" target="*-Info.plist">
<string>To pick images</string>
</config-file>
<config-file parent="NFCReaderUsageDescription" target="*-Info.plist">
<string>To use NFC</string>
</config-file>
Expand Down Expand Up @@ -136,7 +134,6 @@
<splash height="2436" src="resources/ios/splash/Default-2436h.png" width="1125" />
<splash height="2732" src="resources/ios/splash/Default@2x~universal~anyany.png" width="2732" />
</platform>
<plugin name="cordova-plugin-whitelist" spec="1.3.3" />
<plugin name="cordova-plugin-statusbar" spec="2.4.2" />
<plugin name="cordova-plugin-device" spec="2.0.2" />
<plugin name="cordova-plugin-splashscreen" spec="5.0.2" />
Expand Down
37 changes: 14 additions & 23 deletions example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,27 @@
},
"private": true,
"dependencies": {
"@regulaforensics/cordova-plugin-document-reader-api": "7.1.0",
"@regulaforensics/cordova-plugin-document-reader-core-fullrfid": "7.1.0",
"@regulaforensics/ionic-native-document-reader": "7.1.0",
"cordova-plugin-camera": "7.0.0",
"@awesome-cordova-plugins/camera": "6.6.0",
"@awesome-cordova-plugins/core": "6.6.0",
"@awesome-cordova-plugins/file": "6.6.0",
"@awesome-cordova-plugins/splash-screen": "6.6.0",
"@awesome-cordova-plugins/status-bar": "6.6.0",
"@angular/common": "~13.3.2",
"@angular/core": "~13.3.2",
"@angular/forms": "~13.3.2",
"@angular/platform-browser": "~13.3.2",
"@angular/platform-browser-dynamic": "~13.3.2",
"@angular/router": "~13.3.2",
"@awesome-cordova-plugins/android-permissions": "^5.28.0",
"@awesome-cordova-plugins/core": "^5.28.0",
"@awesome-cordova-plugins/file": "^5.28.0",
"@awesome-cordova-plugins/image-picker": "^5.28.0",
"@awesome-cordova-plugins/splash-screen": "^5.28.0",
"@awesome-cordova-plugins/status-bar": "^5.28.0",
"@ionic/angular": "^6.0.15",
"@ionic/cordova-builders": "^6.1.0",
"cordova-ios": "^6.2.0",
"@regulaforensics/cordova-plugin-document-reader-api": "6.9.1",
"@regulaforensics/cordova-plugin-document-reader-core-fullrfid": "6.9.0",
"@regulaforensics/ionic-native-document-reader": "6.9.1",
"cordova-android": "^10.1.1",
"cordova-android": "12.0.1",
"cordova-ios": "6.3.0",
"cordova-plugin-add-swift-support": "^2.0.2",
"cordova-plugin-android-permissions": "^1.1.0",
"cordova-plugin-file": "^6.0.2",
"cordova-plugin-telerik-imagepicker": "^2.3.5",
"cordova-plugin-file": "8.0.1",
"core-js": "^3.6.5",
"rxjs": "~6.6.3",
"tslib": "^2.0.1",
Expand All @@ -61,7 +59,6 @@
"cordova-plugin-ionic-webview": "^5.0.0",
"cordova-plugin-splashscreen": "^6.0.0",
"cordova-plugin-statusbar": "^2.4.3",
"cordova-plugin-whitelist": "^1.3.5",
"jasmine-core": "~4.0.1",
"jasmine-spec-reporter": "~6.0.0",
"karma": "~6.3.17",
Expand All @@ -79,18 +76,12 @@
"plugins": {
"@regulaforensics/cordova-plugin-document-reader-api": {},
"@regulaforensics/cordova-plugin-document-reader-core-fullrfid": {},
"cordova-plugin-android-permissions": {},
"cordova-plugin-telerik-imagepicker": {
"PHOTO_LIBRARY_USAGE_DESCRIPTION": " "
},
"cordova-plugin-camera": {},
"cordova-plugin-file": {},
"cordova-plugin-whitelist": {},
"cordova-plugin-statusbar": {},
"cordova-plugin-device": {},
"cordova-plugin-splashscreen": {},
"cordova-plugin-ionic-webview": {
"ANDROID_SUPPORT_ANNOTATIONS_VERSION": "27.+"
},
"cordova-plugin-ionic-webview": {},
"cordova-plugin-ionic-keyboard": {}
},
"platforms": [
Expand Down
6 changes: 2 additions & 4 deletions example/src/app/home/home.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ import { CommonModule } from '@angular/common';
import { IonicModule } from '@ionic/angular';
import { FormsModule } from '@angular/forms';
import { RouterModule } from '@angular/router';
import { ImagePicker } from "@awesome-cordova-plugins/image-picker/ngx";
import { AndroidPermissions } from '@awesome-cordova-plugins/android-permissions/ngx';
import { Camera } from "@awesome-cordova-plugins/camera/ngx"
import { DocumentReader } from '@regulaforensics/ionic-native-document-reader/ngx';

import { HomePage } from './home.page';
Expand All @@ -22,8 +21,7 @@ import { HomePage } from './home.page';
])
],
providers:[
ImagePicker,
AndroidPermissions,
Camera,
DocumentReader
],
declarations: [HomePage]
Expand Down
Loading

0 comments on commit 96bf584

Please sign in to comment.