-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jenkins
committed
Mar 1, 2024
1 parent
a451e97
commit 07c6ac3
Showing
26 changed files
with
7,890 additions
and
6,332 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.