DocsPluginsShowcaseReleases
npmStar us on GitHub

Getting Started

IntroductionInstallationProject StructureLayouts and PagesLinking and Navigating

Routing

Folder-Based RoutingFile-Based RoutingDynamic RoutesParallel RoutesIntercepting RoutesCatch-All RoutesMDX & Markdown Pages

Special Files

Loading UIError BoundariesTemplateDefaultNot Found

Data Fetching

LoadersActionsAccessing Route Data

Metadata

Metadata & SEOOpen Graph & TwitterIcons & Favicons

API Routes

API Routes OverviewPlain Function HandlersHono IntegrationDynamic API Routes

Environment Variables

OverviewPrefixes & Client ExposureUsing in API Routes

Styling

CSS OverviewTailwind CSSCSS Modules

Platforms

WebWindowsmacOSLinuxAndroidiOS

Deployment

Deployment OverviewProduction ServerStatic ExportHosting Providers

A native React framework for building cross-platform applications from a single codebase.

Resources

  • Documentation
  • Plugins
  • Showcase
  • Releases

Community

  • GitHub Discussions
  • Reddit
  • Discord
  • LinkedIn

More

  • npm
  • GitHub
  • Issues
  • License

© 2026 Bini Cooperation.

Android

Build native Android mobile applications with Bini.js.

Android Overview

Bini.js builds native Android applications on top of Tauri v2. Your React app runs inside a native Android WebView with full access to system APIs, permissions, and platform features.

Native APK / AAB

APK for direct install, AAB for Play Store

Code Signing

Keystore signing wired in at scaffold time

Auto Plugin Wiring

bini-native wires Android permissions

Android builds use Tauri's Android backend. Your app runs in a native WebView with full system access.

Requirements

Building Android apps requires the same toolchain on every desktop OS (Windows, macOS, and Linux). The only differences are the paths to your SDK and minor device drivers.

  • Node.js 20.19.0 or higher
  • Java JDK 17 - Download (Eclipse Temurin), then set JAVA_HOME
  • Android Studio - Download. Install the SDK, Build Tools, and NDK, then set ANDROID_HOME.
  • Rust via rustup. Tauri automatically adds the required Android targets for you.
ANDROID_HOME points to your SDK path - ~/Library/Android/sdk on macOS, ~/Android/Sdk on Linux, or %USERPROFILE%\AppData\Local\Android\Sdk on Windows.

Create Project

Create a new Bini.js project targeting Android and install its dependencies:

>_Terminal
$ npx create-bini-app@latest my-app --platform android
$ cd my-app
$ npm install

Or run the interactive prompt and select Android:

>_Terminal
$ npx create-bini-app@latest
>_Terminal
◆
Platforms?
◻ Web Application
◻ Desktop (Windows, macOS, Linux)
◼ Android
◻ iOS
↑/↓ to navigate • Space: select • Enter: confirm
Tip: Pass --app-name "My App" and --org com.acme to skip the native naming prompts.

Development

Run your Android app on an emulator or a connected device. This works the same on every desktop OS:

>_Terminal
$ npm run android

This launches your app with:

  • Hot reload for frontend changes
  • Native Android integration
  • Auto-wired native APIs via bini-native
  • Devtools for debugging

Setting Up an Emulator

  1. Open Android Studio
  2. Go to AVD Manager
  3. Create a virtual device
  4. Start the emulator
  5. Run npm run android
Platform notes: On Windows, install USB drivers for your device. On Linux, install the udev rules so adb can detect connected phones. On macOS, add the Android SDK platform-tools directory to your PATH so adb is available.

Building

Build a release APK or AAB for distribution:

>_Terminal
$ npm run android:build

The build outputs land in src-tauri/gen/android/app/build/outputs/:

OutputPurpose
app-release.apkDirect installation on a device (sideloading, internal testing).
app-release.aabAndroid App Bundle for publishing to the Google Play Store.
The output is a native Android app that runs on Android 5.0 (API 21) and above.

Code Signing

Bini.js supports keystore signing for Android binaries. Set it up or redo it at any time with create-bini-app sign android. If you only need signing for GitHub Actions, use the --ci-only flag.

Prerequisites

Signing requires a Java keystore. If you do not have one, you can generate it with keytool or Android Studio's "Generate Signed Bundle / APK" wizard.

  • A .jks, .keystore, or .p12 keystore file.
  • The key alias.
  • The key password and keystore password.

Local Signing

To sign the APK/AAB locally on your machine, provide your keystore, its alias, and its passwords:

>_Terminal
$ npx create-bini-app sign android

This creates a keystore.properties file inside src-tauri/gen/android/ and patches the Gradle signing config for you:

keystore.properties
storeFile=my-keystore.keystore
storePassword=your-keystore-password
keyAlias=my-key-alias
keyPassword=your-key-password

GitHub Actions Signing

If you want the GitHub Action runner to sign the APK/AAB automatically, you must provide the keystore via GitHub Secrets. Use the --ci-only flag to configure it without setting up local signing:

>_Terminal
$ npx create-bini-app sign android --ci-only

Adding Secrets Manually

To sign the Android build in GitHub Actions, you must add your keystore as repository secrets. bini-deploy does not upload secrets automatically. You must add them manually:

  1. Go to your repository on GitHub and navigate to Settings → Secrets and variables → Actions.
  2. Click New repository secret.
  3. Add ANDROID_KEY_BASE64 with the base64-encoded string of your .jks or .keystore file.
  4. Add ANDROID_KEY_ALIAS with your key alias.
  5. Add ANDROID_KEY_PASSWORD with your key password.
  6. Add ANDROID_KEYSTORE_PASSWORD with your keystore password.
For Google Play Store distribution, your app must be signed with a keystore. Keep the keystore secure and never commit it to version control.

Deployment

You can build the APK/AAB locally using npm run android:build, or let GitHub Actions build it for you by running npm run deploy.

Deploying via GitHub Actions

npm run deploy generates .github/workflows/android.yml and pushes your project to GitHub:

>_Terminal
$ npm run deploy
>_Terminal
◇
Platforms?
◻ Web Application
◻ Desktop (Windows, macOS, Linux)
◼ Android
◻ iOS
↑/↓ to navigate • Space: select • Enter: confirm
◇
GitHub repository URL?
https://github.com/you/my-app
◇
Branch to push to?
● main (default)
○ + New branch...
◇
No .env.signing found. Run create-bini-app sign now?
●Yes/○No
◇
Sign Android for GitHub Actions?
●Yes/○No
◇
Generate deployment files and push to GitHub?
●Yes/○No
◆
Commit message (press Enter for the default):
chore: add deployment configuration

Deployment Flow

  1. Run npm run deploy to generate the CI workflow and push to GitHub.
  2. GitHub Actions builds the signed APK/AAB (if secrets are set) and attaches it to the run as an artifact.
  3. Download the artifact and upload it to the Google Play Console manually.

Store Submission

Once you have a signed .apk or .aab, you can distribute it. Depending on your goals, you have three options:

  • Direct Download (APK): Host the .apk on your website or GitHub Releases. This is common for beta testing, internal apps, and sideloading.
  • Google Play Store: Submit the .aab to the Google Play Console.
  • F-Droid: Publish on F-Droid for an open-source, community-driven app store.

Google Play Store

To publish on the Google Play Store, you need a Google Play Developer account. Upload the signed .aab from src-tauri/gen/android/app/build/outputs/bundle/release/ in the Play Console. See the Google Play Console guide for the specific steps.

Direct Download (APK)

If you are distributing directly (e.g., for internal testing), upload the signed .apk from src-tauri/gen/android/app/build/outputs/apk/release/ to your website or GitHub Releases. Users must enable "Install from unknown sources" on their device to sideload it.

F-Droid

For open-source apps, you can submit your project to F-Droid. See the F-Droid submission guide for the specific steps.

Tip: Google Play requires a signed .aab, not a .apk. The `.apk` is only for direct download and sideloading.

iOS

Build a native iOS app with App Store distribution and TestFlight.

Windows

Build a native Windows app with Authenticode signing and NSIS/MSI installers.

macOS

Build a native macOS app with Developer ID signing and notarization.

Linux

Build a native Linux app with AppImage, .deb, and .rpm bundles.

Was this helpful?
PreviousLinux
NextiOS

On this page

  • Android Overview
  • Requirements
  • Create Project
  • Development
  • Building
  • Code Signing
  • Deployment
  • Store Submission
Edit this page on GitHub

Android

Build native Android mobile applications with Bini.js.

Android Overview

Bini.js builds native Android applications on top of Tauri v2. Your React app runs inside a native Android WebView with full access to system APIs, permissions, and platform features.

Native APK / AAB

APK for direct install, AAB for Play Store

Code Signing

Keystore signing wired in at scaffold time

Auto Plugin Wiring

bini-native wires Android permissions

Android builds use Tauri's Android backend. Your app runs in a native WebView with full system access.

Requirements

Building Android apps requires the same toolchain on every desktop OS (Windows, macOS, and Linux). The only differences are the paths to your SDK and minor device drivers.

  • Node.js 20.19.0 or higher
  • Java JDK 17 - Download (Eclipse Temurin), then set JAVA_HOME
  • Android Studio - Download. Install the SDK, Build Tools, and NDK, then set ANDROID_HOME.
  • Rust via rustup. Tauri automatically adds the required Android targets for you.
ANDROID_HOME points to your SDK path - ~/Library/Android/sdk on macOS, ~/Android/Sdk on Linux, or %USERPROFILE%\AppData\Local\Android\Sdk on Windows.

Create Project

Create a new Bini.js project targeting Android and install its dependencies:

>_Terminal
$ npx create-bini-app@latest my-app --platform android
$ cd my-app
$ npm install

Or run the interactive prompt and select Android:

>_Terminal
$ npx create-bini-app@latest
>_Terminal
◆
Platforms?
◻ Web Application
◻ Desktop (Windows, macOS, Linux)
◼ Android
◻ iOS
↑/↓ to navigate • Space: select • Enter: confirm
Tip: Pass --app-name "My App" and --org com.acme to skip the native naming prompts.

Development

Run your Android app on an emulator or a connected device. This works the same on every desktop OS:

>_Terminal
$ npm run android

This launches your app with:

  • Hot reload for frontend changes
  • Native Android integration
  • Auto-wired native APIs via bini-native
  • Devtools for debugging

Setting Up an Emulator

  1. Open Android Studio
  2. Go to AVD Manager
  3. Create a virtual device
  4. Start the emulator
  5. Run npm run android
Platform notes: On Windows, install USB drivers for your device. On Linux, install the udev rules so adb can detect connected phones. On macOS, add the Android SDK platform-tools directory to your PATH so adb is available.

Building

Build a release APK or AAB for distribution:

>_Terminal
$ npm run android:build

The build outputs land in src-tauri/gen/android/app/build/outputs/:

OutputPurpose
app-release.apkDirect installation on a device (sideloading, internal testing).
app-release.aabAndroid App Bundle for publishing to the Google Play Store.
The output is a native Android app that runs on Android 5.0 (API 21) and above.

Code Signing

Bini.js supports keystore signing for Android binaries. Set it up or redo it at any time with create-bini-app sign android. If you only need signing for GitHub Actions, use the --ci-only flag.

Prerequisites

Signing requires a Java keystore. If you do not have one, you can generate it with keytool or Android Studio's "Generate Signed Bundle / APK" wizard.

  • A .jks, .keystore, or .p12 keystore file.
  • The key alias.
  • The key password and keystore password.

Local Signing

To sign the APK/AAB locally on your machine, provide your keystore, its alias, and its passwords:

>_Terminal
$ npx create-bini-app sign android

This creates a keystore.properties file inside src-tauri/gen/android/ and patches the Gradle signing config for you:

keystore.properties
storeFile=my-keystore.keystore
storePassword=your-keystore-password
keyAlias=my-key-alias
keyPassword=your-key-password

GitHub Actions Signing

If you want the GitHub Action runner to sign the APK/AAB automatically, you must provide the keystore via GitHub Secrets. Use the --ci-only flag to configure it without setting up local signing:

>_Terminal
$ npx create-bini-app sign android --ci-only

Adding Secrets Manually

To sign the Android build in GitHub Actions, you must add your keystore as repository secrets. bini-deploy does not upload secrets automatically. You must add them manually:

  1. Go to your repository on GitHub and navigate to Settings → Secrets and variables → Actions.
  2. Click New repository secret.
  3. Add ANDROID_KEY_BASE64 with the base64-encoded string of your .jks or .keystore file.
  4. Add ANDROID_KEY_ALIAS with your key alias.
  5. Add ANDROID_KEY_PASSWORD with your key password.
  6. Add ANDROID_KEYSTORE_PASSWORD with your keystore password.
For Google Play Store distribution, your app must be signed with a keystore. Keep the keystore secure and never commit it to version control.

Deployment

You can build the APK/AAB locally using npm run android:build, or let GitHub Actions build it for you by running npm run deploy.

Deploying via GitHub Actions

npm run deploy generates .github/workflows/android.yml and pushes your project to GitHub:

>_Terminal
$ npm run deploy
>_Terminal
◇
Platforms?
◻ Web Application
◻ Desktop (Windows, macOS, Linux)
◼ Android
◻ iOS
↑/↓ to navigate • Space: select • Enter: confirm
◇
GitHub repository URL?
https://github.com/you/my-app
◇
Branch to push to?
● main (default)
○ + New branch...
◇
No .env.signing found. Run create-bini-app sign now?
●Yes/○No
◇
Sign Android for GitHub Actions?
●Yes/○No
◇
Generate deployment files and push to GitHub?
●Yes/○No
◆
Commit message (press Enter for the default):
chore: add deployment configuration

Deployment Flow

  1. Run npm run deploy to generate the CI workflow and push to GitHub.
  2. GitHub Actions builds the signed APK/AAB (if secrets are set) and attaches it to the run as an artifact.
  3. Download the artifact and upload it to the Google Play Console manually.

Store Submission

Once you have a signed .apk or .aab, you can distribute it. Depending on your goals, you have three options:

  • Direct Download (APK): Host the .apk on your website or GitHub Releases. This is common for beta testing, internal apps, and sideloading.
  • Google Play Store: Submit the .aab to the Google Play Console.
  • F-Droid: Publish on F-Droid for an open-source, community-driven app store.

Google Play Store

To publish on the Google Play Store, you need a Google Play Developer account. Upload the signed .aab from src-tauri/gen/android/app/build/outputs/bundle/release/ in the Play Console. See the Google Play Console guide for the specific steps.

Direct Download (APK)

If you are distributing directly (e.g., for internal testing), upload the signed .apk from src-tauri/gen/android/app/build/outputs/apk/release/ to your website or GitHub Releases. Users must enable "Install from unknown sources" on their device to sideload it.

F-Droid

For open-source apps, you can submit your project to F-Droid. See the F-Droid submission guide for the specific steps.

Tip: Google Play requires a signed .aab, not a .apk. The `.apk` is only for direct download and sideloading.

iOS

Build a native iOS app with App Store distribution and TestFlight.

Windows

Build a native Windows app with Authenticode signing and NSIS/MSI installers.

macOS

Build a native macOS app with Developer ID signing and notarization.

Linux

Build a native Linux app with AppImage, .deb, and .rpm bundles.

Was this helpful?
PreviousLinux
NextiOS

On this page

  • Android Overview
  • Requirements
  • Create Project
  • Development
  • Building
  • Code Signing
  • Deployment
  • Store Submission
Edit this page on GitHub