UstadMobile

app-android

This module provides the app for Android. Fragments, activities, services, etc. are here. This is single activity app that uses Jetpack navigation via fragments.

Getting started from source

• Follow steps in the main project README to setup development environment and start the server.
• 
  Run the app by selecting “app-android” in the Android toolbar and clicking the run button.
• Enter the URL of the server and tap “next”. You can use the local IP address of your laptop. e.g. http://192.168.1.42:8087/ where your IP address is 192.168.1.42 (server default port is 8087) . You cannot use 127.0.0.1 or localhost (on the Android device/emulator, this refers to the device/emulator, not the host PC.). If using an emulator, you can use http://10.0.2.2:8087/ (because 10.0.2.2 on an Android emulator always refers to the host PC).
• Enter the username admin, and the admin password. See main project README for how to find the initial admin password.

Command line debug APK build

(run from root project directory):

Linux/MacOS

$ ./gradlew app-android:assembleDebug

Windows:

$ gradlew app-android:assembleDebug

Command line signing (for release APK) :

This is required when you want to upload the app to Google Play or other app stores. This works as per App Signing Documentation.

Option 1: Create a keystore properties file in project root directory.

Linux/MacOS

$ cp keystore.properties.example keystore.properties

Windows:

$ COPY keystore.properties.example keystore.properties

Edit keystore.properties to specify your signing key (see Remove signing information from your build files official documentation if needed for extra info on properties).

Option 2: Specify the keystore properties location using an environment variable

Set the KEYSTORE environment variable before running the gradle build command

Windows:

SET KEYSTORE=C:\PATH\TO\keystore.properties

Linux/MacOS:

export KEYSTORE=/path/to/keystore.properties

The release variant will now be signed with the key as per keystore.properties.

(run from root project directory):

 $ ./gradlew ':app-android:assembleDebug'

Known issues

• Collapsing toolbar / coordinator layout does not work with Jetpack compose views: see https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/package-summary and https://issuetracker.google.com/issues/174348612

This site is open source. Improve this page.