Project Setup

Gaining Access

The Lucra Android SDK is publicly hosted on Github https://github.com/Lucra-Sports/lucra-android-sdk. Due to this, you will need a Github Personal Access Token (PAT) to pull maven artifacts via Gradle at build time.

Managing your personal access tokens - GitHub DocsGitHub Docs

Select "Classic" with the packages:read permissions and name it "Lucra Token". Once a token is generated, copy this and continue onto the next section, Installation

Installation

With the generated PAT, reference it it in the root level build.gradle.kts, where you'll specify the Github Maven repository to pull Lucra artifacts from. Be sure to include the other repositories as well.

repositories {
        google()
        mavenCentral()
        // Required for Lucra SDK
        maven(url = "https://zendesk.jfrog.io/zendesk/repo")
        // Required for Lucra SDK
        maven {
            name = "LucraGithubPackages"
            url = uri("https://maven.pkg.github.com/Lucra-Sports/lucra-android-sdk")
            credentials {
                val gprUser: String? = findProperty("GPR_USER") as String? ?: System.getenv("GPR_USER")
                val gprKey: String? = findProperty("GPR_KEY") as String? ?: System.getenv("GPR_KEY")

                if (gprUser.isNullOrEmpty()) {
                    throw GradleException("GPR_USER not set in ~ .gradle/gradle.properties, local gradle.properties or as an environment variable.")
                }
                if (gprKey.isNullOrEmpty()) {
                    throw GradleException("GPR_KEY not set in ~ .gradle/gradle.properties, local gradle.properties or as an environment variable.")
                }

                username = gprUser
                password = gprKey // Do not check-in your PAT!
            }
        }
    }

Note: It is not recommended to check-in your PAT into your repository, use the gradle.properties or local.properties approach to reference your PAT at build time, for both your private build machines and any pipelines that require this dependency at build time

In your app/build.gradle.kts specify the artifacts to use in your project

// All surface level APIs to interact with Lucra
implementation("com.lucrasports.sdk:sdk-core:{LATEST-VERSION}")
// Optional for UI functionality
implementation("com.lucrasports.sdk:sdk-ui:{LATEST-VERSION}")

Now, sync and run your project to determine if the PAT was correct and the artifacts are fetched correctly.

Build Requirements

Desurgaring

Some of the code we use requires core library desurgaring, you will need to specify this in your app/build.gradle.kts Read more about desurgaring here

android {
  //...
  compileOptions {
    isCoreLibraryDesugaringEnabled = true
  }
  //...
}

//...
dependencies {
  //...
  coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:2.0.4")
}

Auth0 Compliance (if not already using Auth0)

We use Auth0 for auth, if your app doesn't use it already, add the following to your app's default config.

android {
    //...
    defaultConfig {
        addManifestPlaceholders(mapOf("auth0Domain" to "LUCRA_SDK", "auth0Scheme" to "LUCRA_SDK"))
    }
}

Android Manifest requirements

The following manifest permissions, features, receivers and services are required to use Lucra

<manifest xmlns:android="http://schemas.android.com/apk/res/android">
  <uses-permission android:name="android.permission.CAMERA" />
  <uses-permission android:name="android.permission.INTERNET" />
  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  <uses-permission android:name="android.permission.WAKE_LOCK" />
  <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
  <uses-permission android:name="com.google.android.gms.permission.AD_ID" />
  <uses-permission android:name="android.webkit.PermissionRequest" />
  <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
  <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
  <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
  <uses-permission android:name="com.google.android.providers.gsf.permission.READ_GSERVICES" />
  <uses-permission android:name="android.permission.READ_PHONE_STATE" />
  <uses-permission android:name="android.permission.USE_BIOMETRIC" />
  <uses-feature android:name="android.hardware.camera.autofocus" />
  <uses-feature android:name="android.hardware.camera" />

  <application
  ...
  >

  <!--    Geocomply requirements-->
  <receiver android:name="com.geocomply.client.GeoComplyClientBootBroadcastReceiver"
          android:enabled="true" android:exported="true">
    <intent-filter>
      <action android:name="android.intent.action.BOOT_COMPLETED" />
      <action android:name="android.intent.action.QUICKBOOT_POWERON" />
    </intent-filter>
  </receiver>

  <service android:name="com.geocomply.location.WarmingUpLocationProvidersService"
          android:exported="false" />
  <service android:name="com.geocomply.security.GCIsolatedSecurityService"
          android:exported="false" android:isolatedProcess="true" tools:targetApi="q" />

  <receiver android:name="com.geocomply.client.GeoComplyClientBroadcastReceiver" />
  </application>
</manifest>

Proguard Requirements

#https://issuetracker.google.com/issues/247066506
-dontwarn org.xmlpull.v1.**
-dontwarn org.kxml2.io.**
-dontwarn android.content.res.**
-dontwarn org.slf4j.impl.StaticLoggerBinder
-keep class org.xmlpull.** { *; }
-keepclassmembers class org.xmlpull.** { *; }

Once this is successfully completed, move onto Module Integration