Android Registration Client - Feature Flutter

This repository contains the Android Registration Client software for MOSIP. The feature-flutter branch focuses on integrating Flutter into the client.

Setup

To set up the Android Registration Client with Flutter and Android Studio, follow these steps:

Prerequisites

Flutter SDK (3.10.4): Install Flutter by following the official Flutter installation guide.
Android Studio (or Any IDE of your choice): Download and install Android Studio from the official Android Studio website.

Clone the Repository:

The develop branch of android-reg-client is currently being actively developed. If you wish to access this branch, you can clone the repository by executing the following command in your terminal. Alternatively, you can download one of the releases available in the repository's release section.
git clone -b develop https://github.com/mosip/android-registration-client.git

Active Branches:

release-0.9.x (developer release branch)
develop (active development branch)

Set Up Flutter in Android Studio

Open Android Studio.
Click on “Open an existing Android Studio project" and navigate to the cloned repository.
Open the android-registration-client directory as a project in Android Studio.
Install the Flutter plugin for Android Studio by going to File > Settings > Plugins and searching for "Flutter". Click on "Install" to install the plugin.
Configure the Flutter SDK path by going to File > Settings > Languages & Frameworks > Flutter and setting the Flutter SDK path to the location where you installed Flutter.
Click on the "Apply" button to save the changes.

Customising the Registration Client:

Styling of the application can be configured by modifying these files
lib/utils/app_style.dart, lib/utils/app_config.dart
Application language bundles can be added to this path lib/l10n
Label and application logo can be changed here android/app/src/main/AndroidManifest.xml

Build and Run the Application.

pigeon.sh file contains all the commands required to download dependencies and generate flutter - android native communication code. Run the pigeon.sh file or the commands within the file individually.
Connect an Android device or start an Android emulator.
Open the terminal in Android Studio or use the terminal outside of Android Studio.
Navigate to the android-registration-client directory.
Run the following command to build and run the application:
flutter run

Build debug and release APK.

// Debug APK
flutter build apk --debug

// Release APK
flutter build apk --release

Set up Mock MDS for Biometric Scan.

Mock MDS can be used to mock functionalities of biometric devices. Mock MDS application is CTK compliant and can work as a stand in replacement of android sbi modules for testing and validation.

Install the mock mds application.
Open “SETTINGS“
In Device Config, select: “Registration” from dropdown
In P12 Config:
1. Fill Device Key credentials and upload Device P12 file.
2. Fill FTM Key credentials and upload FTM P12 file.
3. Fill all fields in MOSIP IDA Config.
In Modality Config, set the quality score for Face, Finger and Iris. (these values can also be modified during testing)
Click on “SAVE”.
Then on Home Page, click “LOAD AND VALIDATE CERTIFICATES“.
Result for validation success will be displayed as toast message.

Contributing

If you would like to contribute to the Android Registration Client, please follow the guidelines outlined here.

License

The Android Registration Client is licensed under the MIT License

Support

If you encounter any issues or have any questions, please open an issue on the GitHub repository.