Skip to content

Commit 8ff5029

Browse files
author
ci-bot
committed
Updated projects
1 parent 38d91c1 commit 8ff5029

30 files changed

Lines changed: 1045 additions & 0 deletions

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ There are several sample projects, see the details in the table below.
2828
| [Fingerprint Scanner](Fingerprint) | Demonstrates integration with an external fingerprint scanner. |
2929
| [Online Processing](OnlineProcessing) | Demonstrates how to set up and use the <a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/integration/online-processing/">Online Processing</a> feature. |
3030
| [Feature Delivery](FeatureDelivery) | Demonstrates how to optimize the application size by <a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/optimization/android/feature-delivery/">loading modules in runtime</a> using Google's Play Feature Delivery. |
31+
| [Read mDL](ReadmDL) | Demonstrates how to read mDL. |
3132

3233
## Documentation
3334

ReadmDL/.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*.iml
2+
.gradle
3+
.idea
4+
/local.properties
5+
/.idea/workspace.xml
6+
/.idea/libraries
7+
.DS_Store
8+
/build
9+
/captures
10+
.externalNativeBuild
11+
*.license
12+
*.dat

ReadmDL/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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.

ReadmDL/app/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/build

ReadmDL/app/build.gradle

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
plugins {
2+
id 'com.android.application'
3+
id 'kotlin-android'
4+
}
5+
6+
android {
7+
compileSdk 36
8+
defaultConfig {
9+
applicationId "com.regula.documentreader"
10+
minSdk 21
11+
targetSdk 36
12+
versionCode 1
13+
versionName "1.0"
14+
}
15+
compileOptions {
16+
sourceCompatibility JavaVersion.VERSION_17
17+
targetCompatibility JavaVersion.VERSION_17
18+
}
19+
kotlinOptions {
20+
jvmTarget = "17"
21+
}
22+
buildTypes {
23+
release {
24+
minifyEnabled true
25+
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
26+
}
27+
}
28+
29+
buildFeatures {
30+
viewBinding true
31+
}
32+
namespace 'com.regula.documentreader'
33+
}
34+
35+
dependencies {
36+
//noinspection GradleCompatible
37+
implementation 'androidx.appcompat:appcompat:1.6.1'
38+
implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
39+
implementation 'com.google.android.material:material:1.6.1'
40+
41+
implementation 'com.regula.documentreader.core:fullauthrfid:9.1.+@aar'
42+
implementation 'com.regula.btdevice:api:9.1.+@aar'
43+
implementation('com.regula.documentreader:api:9.1.+@aar') {
44+
transitive = true;
45+
}
46+
}

ReadmDL/app/proguard-rules.pro

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Add project specific ProGuard rules here.
2+
# You can control the set of applied configuration files using the
3+
# proguardFiles setting in build.gradle.
4+
#
5+
# For more details, see
6+
# http://developer.android.com/guide/developing/tools/proguard.html
7+
8+
# If your project uses WebView with JS, uncomment the following
9+
# and specify the fully qualified class name to the JavaScript interface
10+
# class:
11+
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12+
# public *;
13+
#}
14+
15+
# Uncomment this to preserve the line number information for
16+
# debugging stack traces.
17+
#-keepattributes SourceFile,LineNumberTable
18+
19+
# If you keep the line number information, uncomment this to
20+
# hide the original source file name.
21+
#-renamesourcefileattribute SourceFile
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
3+
4+
<uses-permission android:name="android.permission.NFC" />
5+
<uses-permission android:name="android.permission.INTERNET" />
6+
<!--Manifest.permission.READ_PHONE_STATE is required if you are using a license by device Id-->
7+
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
8+
9+
<application
10+
android:allowBackup="true"
11+
android:icon="@mipmap/ic_launcher"
12+
android:roundIcon="@mipmap/ic_launcher_round"
13+
android:label="@string/app_name"
14+
android:supportsRtl="true"
15+
android:theme="@style/Theme.AppCompat.NoActionBar">
16+
17+
<activity
18+
android:name=".MainActivity"
19+
android:exported="true"
20+
android:screenOrientation="portrait">
21+
<intent-filter>
22+
<action android:name="android.intent.action.MAIN" />
23+
<category android:name="android.intent.category.LAUNCHER" />
24+
</intent-filter>
25+
</activity>
26+
</application>
27+
</manifest>
Binary file not shown.

0 commit comments

Comments
 (0)