Quickstart: Android

Requirements: Android 8.0 (API 26) or newer, Kotlin, Jetpack Compose, Java 17.

1. Install

Build version 1.0.0 from its Git tag into your local Maven repository:

git clone --branch 1.0.0 https://github.com/tweaklane/tweaklane-android
cd tweaklane-android && ./gradlew :tweaklane:publishToMavenLocal

Then add mavenLocal() to your repositories and the dependency to your app module:

// settings.gradle.kts
dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        mavenLocal()
    }
}

// app/build.gradle.kts
dependencies {
    implementation("com.tweaklane:tweaklane-android:1.0.0")
}

2. Same model as iOS and the web

The Android SDK follows the same steps as the iOS quickstart, with Composables in place of SwiftUI views:

1. Register each component in a catalog: a stable id, a Composable builder, a props schema, its alternatives and a lock level.
2. Provide a default document per screen.
3. Create the engine with your catalog and render each screen through it.
4. Start edit mode where your app wants it.
5. Connect sync with your public SDK key, your {TWEAKLANE_URL} and a token provider that asks your backend for a user token.

The layout documents, catalog manifest, validation rules and issue codes are identical on every platform: the Android SDK runs the same shared fixtures as the iOS SDK and the server.

The package README carries the complete Kotlin API.

3. Strings

Edit-mode strings ship in English, German, Spanish, French, Italian, Japanese, Korean, Dutch, Polish, Brazilian Portuguese, Swedish, Turkish and Simplified Chinese, looked up by the same keys as iOS.

4. Connect your backend

User tokens work the same on every platform. See Connect your backend.