-
Notifications
You must be signed in to change notification settings - Fork 10
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
Feb 22, 2024
1 parent
5048a96
commit 1b054ca
Showing
50 changed files
with
11,308 additions
and
9,206 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,51 +1,19 @@ | ||
# Regula Document Reader (React Native) | ||
# Regula Document Reader SDK for React Native | ||
|
||
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 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 this repository using the command `git clone https://github.com/regulaforensics/react-native-document-reader.git`. | ||
3. Run the following commands in Terminal: | ||
```bash | ||
$ cd example | ||
$ npm install | ||
$ cd ios | ||
$ pod install | ||
``` | ||
|
||
**Note**: make sure that Metro Bundler is running when you run your app. Otherwise, run `npx react-native start` command. If it fails to start, run `git init` from Project root, then `npx react-native start`. | ||
|
||
4. Android: | ||
* Copy the `regula.license` file to the `example/android/app/src/main/assets` folder. | ||
* Run `npx react-native 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**: `npx react-native log-android` is used to view logs. | ||
|
||
**Note**: if the running failed with the following error `Error: spawn ./gradlew EACCES`, try to run the following command `chmod +x gradlew` within the `example/android` directory. | ||
|
||
5. iOS: | ||
* Copy the `regula.license` file to the `example/ios/DocumentReader` folder. | ||
* Run `npx react-native 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/react-native). | ||
|
||
## Additional information | ||
If you have any technical questions, feel free to [contact](mailto:[email protected]) us or create issue [here](https://github.com/regulaforensics/react-native-document-reader/issues). | ||
You can find documentation [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/react-native). | ||
|
||
## 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
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.