|
| 1 | +# Basic Kotlin Sample Project (Android) |
| 2 | + |
| 3 | +* [Overview](#overview) |
| 4 | +* [Installation](#installation) |
| 5 | +* [Troubleshooting](#troubleshooting) |
| 6 | +* [Documentation](#documentation) |
| 7 | +* [Demo Application](#demo-application) |
| 8 | +* [Technical Support](#technical-support) |
| 9 | +* [Business Enquiries](#business-enquiries) |
| 10 | + |
| 11 | +## Overview |
| 12 | + |
| 13 | +Sample project in Kotlin, demonstrating the reading mDL |
| 14 | + |
| 15 | +## Installation |
| 16 | + |
| 17 | +1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`. |
| 18 | +2. Open the `ReadmDL` project in an IDE. |
| 19 | +3. Add license and database files to the project: |
| 20 | + - Visit [Regula Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps. |
| 21 | + - Copy the license file to the project: `ReadmDL/app/src/main/res/raw/` |
| 22 | +4. Change the application ID to the one you have specified during the registration at the [Client Portal](https://client.regulaforensics.com/). |
| 23 | +5. Run the project. |
| 24 | + |
| 25 | +**Note:** Android Gradle plugin requires Java 11 to run. |
| 26 | + |
| 27 | +## Troubleshooting |
| 28 | + |
| 29 | +If you have issues with the license verification when running the application, check the following: |
| 30 | + |
| 31 | +1. The OS, which you use, is specified in the license (Android). |
| 32 | +2. The application ID, which you use, is specified in the license. |
| 33 | +3. The license is valid (not expired). |
| 34 | +4. The date and time on the device, where you run the application, are valid. |
| 35 | +5. You use the latest release version of the Document Reader SDK. |
| 36 | +6. You placed the license into the project as described in the [Installation](#installation) section. |
| 37 | + |
| 38 | +## Documentation |
| 39 | + |
| 40 | +<a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/">Document Reader SDK Mobile Documentation</a> |
| 41 | + |
| 42 | +## Demo Application |
| 43 | + |
| 44 | +<a target="_blank" href="https://play.google.com/store/apps/details?id=com.regula.documentreader">Regula Document Reader Android Demo Application on Google Play</a> |
| 45 | + |
| 46 | +## Technical Support |
| 47 | + |
| 48 | +To submit a request to the Support Team, visit <a target="_blank" href="https://support.regulaforensics.com/hc/en-us/requests/new?utm_source=github">Regula Help Center</a>. |
| 49 | + |
| 50 | +## Business Enquiries |
| 51 | + |
| 52 | +To discuss business opportunities, fill the <a target="_blank" href="https://explore.regula.app/docs-support-request">Enquiry Form</a> and specify your scenarios, applications, and technical requirements. |
0 commit comments