Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Prerequisites

Clone the Repository:

  1. The feature-flutter 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.

    Code Block
    languagebash
    git clone -b feature-flutterdevelop https://github.com/mosip/android-registration-client.git

Active Branches:

Set Up Flutter in Android Studio

...

  1. 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.

  2. Connect an Android device or start an Android emulator.

  3. Open the terminal in Android Studio or use the terminal outside of Android Studio.

  4. Navigate to the android-registration-client directory.

  5. Run the following command to build and run the application:

    Code Block
    languagebash
    flutter run

Build debug and release APK.

Code Block
languagebash
// 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.

  1. Install the mock mds application.

  2. Open “SETTINGS“

  3. In Device Config, select: “Registration” from dropdown

  4. 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.

  5. In Modality Config, set the quality score for Face, Finger and Iris. (these values can also be modified during testing)

  6. Click on “SAVE”.

  7. Then on Home Page, click “LOAD AND VALIDATE CERTIFICATES“.

  8. 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.

...

The Android Registration Client is licensed under the Apache MIT License 2.0.

Support

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

...