Kltemplate

0.0.6indexed

Facilitates template-based project generation, streamlining setup and configuration processes for new projects with customizable templates and predefined structures.

AndroidJVMWasm·mshdabiola/Kltemplate

Stars

—

Used by

dependents

—

Health

/ 100

kltemplate

Application Screenshot

Overview

kltemplate is a modern Kotlin Multiplatform library template designed to accelerate the development of cross-platform applications and libraries. It provides a robust, modular, and scalable foundation for targeting Android, JVM, and Web (WASM/JS) platforms using a single codebase.

The template leverages the latest Kotlin Multiplatform, Compose Multiplatform, and Gradle conventions, with a focus on clean architecture, testability, and developer experience.

Features

Project Structure

.
├── app/                # Multiplatform application entry points
├── library/            # Shared library modules (UI, model, etc.)
├── benchmarks/         # Android macrobenchmark and baseline profile
├── build-logic/        # Gradle convention plugins and build scripts
├── kotlin-js-store/    # JS-specific modules (if any)
├── gradle/             # Gradle wrapper and version catalogs
├── spotless/           # Formatting configuration
├── README.md
├── CHANGELOG.md
└── ...

Getting Started

Prerequisites

JDK 21+
Android Studio Giraffe+
Node.js (for JS/WASM target)
Gradle 8.0+ (wrapper included)

Cloning the Repository

git clone https://github.com/mshdabiola/kltemplate.git
cd kltemplate

Building the Project

Build all targets:

./gradlew build

Build and run the Android app:

./gradlew :app:installDebug
adb shell am start -n com.hobit.sample/.MainActivity

Build and run the JVM desktop app:

./gradlew :app:runJvm

Build and run the WASM/JS app (served locally):

./gradlew :app:jsBrowserDevelopmentRun

Usage

As a Template

Clone or use as a GitHub template to start your own multiplatform project.
Rename packages and update module names as needed.
Add your business logic to library/ and UI to app/.

As a Library

If you publish modules from library/, consumers can add dependencies via Maven Central or GitHub Packages (see Publishing).

Modules

app: Entry points for Android, JVM, and WASM/JS.
library: Shared UI components, models, and utilities.
benchmarks: Android macrobenchmark and baseline profile tests.
build-logic: Custom Gradle plugins for convention-driven builds.

Development

Code Style

Follows Kotlin Coding Conventions.
Run formatting and lint checks before committing:

./gradlew spotlessCheck detekt

Testing

Run all tests:

./gradlew test

Run Compose UI tests (Android):

./gradlew :library:connectedAndroidTest

Benchmarking

Generate and collect baseline profiles:

./gradlew :benchmarks:connectedAndroidTest

Publishing

The template is pre-configured for publishing to Maven Central and GitHub Packages. Update groupId, versionName, and credentials in gradle/libs.versions.toml and GitHub secrets.

To publish: