An open API service indexing awesome lists of open source software.

https://github.com/clerk/clerk-android

Android SDK for Clerk
https://github.com/clerk/clerk-android

Last synced: 2 months ago
JSON representation

Android SDK for Clerk

Awesome Lists containing this project

README

          












Official Clerk Android SDK




Clerk helps developers build user management. We provide streamlined user experiences for your users to sign up, sign in, and manage their profile.

[![chat on Discord](https://img.shields.io/discord/856971667393609759.svg?logo=discord)](https://clerk.com/discord)
[![documentation](https://img.shields.io/badge/documentation-clerk-green.svg)](https://clerk.com/docs)
[![twitter](https://img.shields.io/twitter/follow/ClerkDev?style=social)](https://twitter.com/intent/follow?screen_name=ClerkDev)

---

## Usage

### Creating a Clerk Application

1. [Sign up for an account](https://dashboard.clerk.com/sign-up?utm_source=github&utm_medium=clerk_android_repo_readme)
2. Create an application in your Clerk dashboard
3. Copy your **Publishable Key** from the API Keys section

### Installation

The Clerk Android SDK is available as two separate artifacts:

- **`clerk-android-api`** – Core API and authentication logic (required)
- **`clerk-android-ui`** – Prebuilt Jetpack Compose UI components (optional, includes API)

Add the desired artifact to your app's `build.gradle(.kts)`:

#### API Only

Use this if you want to build your own custom UI:

```kotlin
dependencies {
implementation("com.clerk:clerk-android-api:0.1.28")
}
```

#### With Prebuilt UI Components

Use this if you want to use the prebuilt Jetpack Compose UI components:

```kotlin
dependencies {
implementation("com.clerk:clerk-android-ui:0.1.3")
}
```

> 💡 **Tip:** Check Maven Central for the latest versions:
> [clerk-android-api](https://central.sonatype.com/artifact/com.clerk/clerk-android-api) |
> [clerk-android-ui](https://central.sonatype.com/artifact/com.clerk/clerk-android-ui)

## Samples

#### Quickstart
`samples/quickstart`: This is a paired repo with the [Android Quickstart guide](https://clerk.com/docs/quickstarts/android). It provides a simple
example of how to integrate Clerk into an Android application, demonstrating user sign-up, sign-in,
and profile management. See the [README](samples/quickstart/README.md) for more info

#### Custom flows
`samples/custom-flows`: This is a paired repo with the [Custom Flows guide](https://clerk.com/docs/custom-flows/overview). It showcases how to
implement custom authentication flows using Clerk, including advanced scenarios like multi-factor
authentication and reset password. See the [README](samples/custom-flows/README.md) for more info

#### Linear Clone
`samples/linear-clone`: This is an example that shows how you might integrate with compose navigation, it is a native recreation of the Linear auth flow (which is web based)
and includes Sign in with Google, Passkey authentication, Sign out, and Email Code Authentication. See the [README](samples/linear-clone/README.md) for more info.

#### Prebuilt UI
`samples/prebuilt-ui`: This is an example that shows how to integrate the Clerk prebuilt UI components. See the [README](samples/prebuilt-ui/README.md) for more info.

## Documentation

- [Reference Documentation](https://clerk-android.clerkstage.dev)
- [Clerk Docs](https://clerk.com/docs)
- [Android Integration Guide](https://clerk.com/docs/quickstarts/android)

## 📝 License

This project is licensed under the **MIT license**.

See [LICENSE](https://github.com/clerk/clerk-android/blob/main/LICENSE) for more information.