Simprints Documentation
  • Introduction
    • Goals
    • Audience
    • Disclaimer
  • Product Overview
    • Product Overview
      • Simprints ID (SID)
        • Enrolment
        • Verification
        • Indentification
      • Biometrics
        • Fingerprints Recognition
          • Vero Fingerprint Scanners
        • Face Recognition
      • SID Intents Launcher
      • Cloud Backend
      • Data Collection Platforms
        • DHIS2
        • CommCare
        • ODK + Survey CTO
  • Architecture
    • System architecture
      • Mobile
        • Simprints ID (SID)
          • Project structure
          • Biometric flow orchestration
  • Installation
    • Installation, Quick Start and Device Requirements
      • Installation
      • Quick Start Guide
      • Device Requirements
  • Security & Privacy
    • Security & Privacy Considerations
      • Security Policy
      • Responsible Use
      • Privacy Policy
      • Cookie Policy
  • Development
    • Getting setup
    • Simprints for Developers
      • Simprints for Developers
      • Integrating with Simprints
        • Getting Started
        • Enrollment
        • Identification
        • Verification
        • Exit Forms
        • Confidence Score Bands
        • Enrolment & Identification +
        • Handling Errors
        • Metadata
      • Other Intergrations
        • ODK Integrations + SurveyCTO
          • Enrol
          • Identify
          • Verify
          • FAQ
        • CommCare Integration
          • CommCare: Enrolment
          • Identification
          • FAQs
          • ↔️CoSync
        • DHIS2
  • Troubleshooting
    • FAQs
    • Common Issues
  • Community & Support
    • Support Channels
    • Community Guidelines
    • Open Source Contributions
  • Product Roadmap
    • Product Roadmap
      • Current Releases
      • Previous Releases
      • Submit an Idea or Request
  • Licence
  • Contribution Guidelines
    • Contribution Guidelines
      • Code Contributions
      • Bug Reports
      • Feature Requests
  • Supporting Partners
Powered by GitBook
LogoLogo
On this page

Was this helpful?

Edit on GitHub
  1. Development

Getting setup

Prerequisites:

  • A Linux, Windows, macOS computer

  • Git client installed

  • Android Studio installed

Step 1: Clone the Simprints repository

Open a terminal window and navigate to the desired location on your computer where you want to clone the repository. Then, run the following command:

git clone https://github.com/Simprints/**Repo of choice**

This will clone the Simprints repository to the specified location.

Step 2: Build the Simprints SDK

To build the Simprints SDK, run the following command:

./gradlew build

This will build the SDK and produce an APK file in the build/outputs/apk directory.

Step 3: Load the APK onto a phone

Connect your phone to your computer via USB and enable USB debugging mode on your phone. Then, copy the APK file from the build/outputs/apk directory to your phone.

Step 4: Load the APK into the IDE

Open the APK file in your Android Studio IDE. This will install the Simprints SDK on your phone and open the app in the IDE.

Step 5: Make changes to the code

Make the desired changes to the code in the repository.

Step 6: Build the updated SDK

To build the updated SDK, run the following command in the cloned repository directory:

./gradlew build

This will overwrite the existing APK file in the build/outputs/apk directory with the updated version.

Step 7: Reload the updated SDK onto the phone

Copy the updated APK file from the build/outputs/apk directory to your phone.

Step 8: Test the updated SDK

Launch the Simprints app on your phone and test the updated functionality.

Notes:

  • You can run the gradlew build command repeatedly to build the SDK with the latest changes.

  • The first time you run the gradlew build command, downloading and installing the required dependencies may take some time.

  • Check the logs for more information if you encounter errors during the build process.

PreviousCookie PolicyNextSimprints for Developers

Last updated 8 months ago

Was this helpful?