
Enables multiplatform library development with a sample app across desktop, Android, iOS, and web. Supports local and central Maven publishing with detailed setup instructions.
This repository is a ready-to-ship template for building and releasing Compose Multiplatform libraries. It automates the heavy lifting so you can focus on your API and UX:
/demo so users can try your library in the browser./api.https://github.com/user-attachments/assets/b574fc22-eff4-452e-adf6-02ba54b6bbd3
New to this template? Check out the complete guide: 📖 Using This Template for Your Library
Quick setup:
Note: You don't need a pre-existing
<username>.github.iosite. GitHub Pages will automatically createhttps://<username>.github.io/<your-library-name>/when you run your first release.
For contributors: See CONTRIBUTING.md for development guidelines.
Download and try the sample app on your platform without building from source:
| Platform | Download Link |
|---|---|
| 🍏 macOS (Intel) | |
| 🍎 macOS (Apple Silicon) | |
| 🪟 Windows | |
| 🐧 Linux | |
| 🤖 Android | |
| 🌐 Web (Wasm) | |
| iOS Simulator |
Option 1: Drag and Drop
Option 2: ADB Install
adb install sample-app-android-unsigned.apksample-app-wasm.zip
index.html in a web browserNote: You can also try the live demo without downloading: Try Live Demo
sample-app-ios-simulator.zip from the latest release
sample-app-ios-simulator.app
.app onto the Simulator window OR run:
xcrun simctl install booted /path/to/sample-app-ios-simulator.appDownload the DMG for your Mac architecture (Intel or Apple Silicon)
When you open the app for the first time, macOS Gatekeeper may block it since it is an open-source build signed ad-hoc. Follow these 6 sequential steps to install and run the app:
1. Mount DMG & Install
|
2. Gatekeeper Block Alert
|
3. Open System Settings
|
4. Click "Open Anyway"
|
5. Authenticate Security Dialog
|
6. Click "Open" to Launch
|
Step-by-step instructions:
This is a normal security step for all open-source and CI-generated Mac executables. Apps are signed ad-hoc for internal/dev use, not with a public Apple developer ID.
Tip: Unsure about your Mac's type? Click the Apple logo → "About This Mac". If it says Intel, download x64; if it says M1, M2, or M3, download arm64.
.deb filesudo dpkg -i sample-app-linux.debsample in the terminal!You can also run Gradle tasks in the terminal:
./gradlew run to run application./gradlew package to store native distribution into build/compose/binaries
./gradlew :sample:composeApp:run
sample/iosApp/iosApp.xcodeproj in Xcode and run the sample app./gradlew :sample:composeApp:wasmJsBrowserRun
This repo ships with an automated CI/CD pipeline that builds, tests, packages, releases, and deploys docs & demo automatically on version tags (v*).
flowchart TD
A["Lint & BCV apiCheck"] --> B["Build & Test - Library + Sample (all targets)"]
B --> C["Parikshan E2E Tests (JVM, Wasm, Android, iOS Simulator)"]
C --> D["Build Artifacts - APK • DMG (Intel/Apple Silicon) • MSI • DEB • iOS Simulator zip • Wasm bundle"]
D --> E["Create GitHub Release & Upload Artifacts"]
E --> F["Publish to Maven Central"]
E --> G["Deploy GitHub Pages (Docsify Site + Dokka API Docs + Live Wasm Demo)"]Pipeline Highlights:
apiCheck)..app zip, and Wasm web bundles directly to GitHub Releases.Publish to Maven Local:
./gradlew :library-module:publishToMavenLocalArtifacts will be installed in ~/.m2/repository/io/github/aryapreetam/fiblib/.
Publish to Maven Central:
Publishing is handled automatically via GitHub Actions whenever you push a version tag (e.g. v0.0.1). For instructions on setting up GPG signing keys and Sonatype Central credentials, see the GitHub Secrets Setup Guide.
By default, this template produces a lightweight, single-module KMP library (:library-module), which is ideal for most utility and UI libraries. However, as your library grows in complexity, you can manually expand it into a multi-module library.
We provide a detailed step-by-step guide: 👉 Transitioning to a Multi-Module Library Structure Guide
See CONTRIBUTING.md for contribution guidelines.
This template was built with inspiration and learnings from the Kotlin Multiplatform community:
MIT License © 2025 aryapreetam and contributors. See LICENSE for details.
This repository is a ready-to-ship template for building and releasing Compose Multiplatform libraries. It automates the heavy lifting so you can focus on your API and UX:
/demo so users can try your library in the browser./api.https://github.com/user-attachments/assets/b574fc22-eff4-452e-adf6-02ba54b6bbd3
New to this template? Check out the complete guide: 📖 Using This Template for Your Library
Quick setup:
Note: You don't need a pre-existing
<username>.github.iosite. GitHub Pages will automatically createhttps://<username>.github.io/<your-library-name>/when you run your first release.
For contributors: See CONTRIBUTING.md for development guidelines.
Download and try the sample app on your platform without building from source:
| Platform | Download Link |
|---|---|
| 🍏 macOS (Intel) | |
| 🍎 macOS (Apple Silicon) | |
| 🪟 Windows | |
| 🐧 Linux | |
| 🤖 Android | |
| 🌐 Web (Wasm) | |
| iOS Simulator |
Option 1: Drag and Drop
Option 2: ADB Install
adb install sample-app-android-unsigned.apksample-app-wasm.zip
index.html in a web browserNote: You can also try the live demo without downloading: Try Live Demo
sample-app-ios-simulator.zip from the latest release
sample-app-ios-simulator.app
.app onto the Simulator window OR run:
xcrun simctl install booted /path/to/sample-app-ios-simulator.appDownload the DMG for your Mac architecture (Intel or Apple Silicon)
When you open the app for the first time, macOS Gatekeeper may block it since it is an open-source build signed ad-hoc. Follow these 6 sequential steps to install and run the app:
1. Mount DMG & Install
|
2. Gatekeeper Block Alert
|
3. Open System Settings
|
4. Click "Open Anyway"
|
5. Authenticate Security Dialog
|
6. Click "Open" to Launch
|
Step-by-step instructions:
This is a normal security step for all open-source and CI-generated Mac executables. Apps are signed ad-hoc for internal/dev use, not with a public Apple developer ID.
Tip: Unsure about your Mac's type? Click the Apple logo → "About This Mac". If it says Intel, download x64; if it says M1, M2, or M3, download arm64.
.deb filesudo dpkg -i sample-app-linux.debsample in the terminal!You can also run Gradle tasks in the terminal:
./gradlew run to run application./gradlew package to store native distribution into build/compose/binaries
./gradlew :sample:composeApp:run
sample/iosApp/iosApp.xcodeproj in Xcode and run the sample app./gradlew :sample:composeApp:wasmJsBrowserRun
This repo ships with an automated CI/CD pipeline that builds, tests, packages, releases, and deploys docs & demo automatically on version tags (v*).
flowchart TD
A["Lint & BCV apiCheck"] --> B["Build & Test - Library + Sample (all targets)"]
B --> C["Parikshan E2E Tests (JVM, Wasm, Android, iOS Simulator)"]
C --> D["Build Artifacts - APK • DMG (Intel/Apple Silicon) • MSI • DEB • iOS Simulator zip • Wasm bundle"]
D --> E["Create GitHub Release & Upload Artifacts"]
E --> F["Publish to Maven Central"]
E --> G["Deploy GitHub Pages (Docsify Site + Dokka API Docs + Live Wasm Demo)"]Pipeline Highlights:
apiCheck)..app zip, and Wasm web bundles directly to GitHub Releases.Publish to Maven Local:
./gradlew :library-module:publishToMavenLocalArtifacts will be installed in ~/.m2/repository/io/github/aryapreetam/fiblib/.
Publish to Maven Central:
Publishing is handled automatically via GitHub Actions whenever you push a version tag (e.g. v0.0.1). For instructions on setting up GPG signing keys and Sonatype Central credentials, see the GitHub Secrets Setup Guide.
By default, this template produces a lightweight, single-module KMP library (:library-module), which is ideal for most utility and UI libraries. However, as your library grows in complexity, you can manually expand it into a multi-module library.
We provide a detailed step-by-step guide: 👉 Transitioning to a Multi-Module Library Structure Guide
See CONTRIBUTING.md for contribution guidelines.
This template was built with inspiration and learnings from the Kotlin Multiplatform community:
MIT License © 2025 aryapreetam and contributors. See LICENSE for details.