Building a flexible cross-platform SDK with modern architecture, shared UI components, comprehensive testing, and CI/CD integration. Ideal for creating robust libraries with platform-specific implementations and performance monitoring.
A modern Kotlin Multiplatform SDK template for building cross-platform libraries and applications. This template provides a robust foundation for creating SDKs that work seamlessly across Android and iOS platforms. Currently in development - this template is designed to be forked and customized for your specific SDK needs.
SDKForge.Template/
├── app-android/ # Android sample application
├── app-ios/ # iOS sample application
├── app-shared/ # Shared sample UI components (Compose Multiplatform)
├── shared/ # Main SDK library with all components
├── shared-core/ # Core shared functionality
├── shared-template/ # Template for shared modules
├── build-logic/ # Gradle build logic and conventions
├── internal-benchmark/ # Performance benchmarks
└── internal-ktlint/ # Custom ktlint rules
Note: This project is currently in development and not yet published to any repository. Installation instructions will be available once the project is published.
Once published, you'll be able to install the SDK using:
dependencies {
implementation("dev.sdkforge.template:shared:1.0.0")
implementation("dev.sdkforge.template:shared-core:1.0.0")
}
dependencies {
implementation 'dev.sdkforge.template:shared:1.0.0'
implementation 'dev.sdkforge.template:shared-core:1.0.0'
}
<dependency>
<groupId>dev.sdkforge.template</groupId>
<artifactId>shared</artifactId>
<version>1.0.0</version>
</dependency>
This project serves as a template for creating Kotlin Multiplatform SDKs. To use it:
shared-* modulesThe template provides a modular structure with platform-specific implementations:
// Common interface (shared/src/commonMain/kotlin/dev/sdkforge/template/core/Platform.kt)
interface Platform {
val name: String
val version: String
}
expect val currentPlatform: Platform
// shared-core/src/androidMain/kotlin/dev/sdkforge/template/core/Platform.android.kt
actual val currentPlatform: Platform = object : Platform {
override val name: String get() = "Android"
override val version: String get() = android.os.Build.VERSION.SDK_INT.toString()
}
// shared-core/src/iosMain/kotlin/dev/sdkforge/template/core/Platform.ios.kt
import platform.UIKit.UIDevice
actual val currentPlatform: Platform = object : Platform {
override val name: String get() = UIDevice.currentDevice.systemName
override val version: String get() = UIDevice.currentDevice.systemVersion
}
The template includes a shared UI component using Compose Multiplatform:
// app-shared/src/commonMain/kotlin/dev/sdkforge/template/app/App.kt
@Composable
fun App(
modifier: Modifier = Modifier,
) = ApplicationTheme {
Surface(
modifier = modifier,
color = MaterialTheme.colorScheme.background,
) {
Column(
verticalArrangement = Arrangement.spacedBy(
space = 8.dp,
alignment = Alignment.CenterVertically,
),
horizontalAlignment = Alignment.CenterHorizontally,
) {
Text(
text = "Platform name: ${currentPlatform.name}",
)
Text(
text = ,
)
}
}
}
Access SDK version information through the Library object:
// shared/src/commonMain/kotlin/dev/sdkforge/template/Library.kt
data object Library {
const val VERSION = "0.0.1"
}
// Usage
val sdkVersion = Library.VERSION
./gradlew test
# Android tests
./gradlew app-android:test
# iOS tests
./gradlew app-ios:test
./gradlew internal-benchmark:connectedAndroidTest
shared-* directorybuild.gradle.ktsshared module to export the new moduleThis project uses KtLint for code formatting. Run the following to check and fix code style:
./gradlew ktlintCheck
./gradlew ktlintFormat
The project uses dependency guard to prevent dependency drift:
./gradlew dependencyGuard
We welcome contributions! Please see our Contributing Guide for details.
This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.
We take security seriously. Please report security vulnerabilities to volodymyr.nevmerzhytskyi@sdkforge.dev.
Do NOT create public GitHub issues for security vulnerabilities.
This project is licensed under the MIT License - see the LICENSE file for details.
Made with ❤️ by the SDKForge Team
Clone the repository:
git clone https://github.com/SDKForge/template-sdk.git SDKForgeTemplate
cd SDKForgeTemplate
Build the project:
./gradlew build
Run tests:
./gradlew lint ktlintCheck dependencyGuard checkLegacyAbi
Generate documentation:
./gradlew dokkaHtml
Surfaced from shared tags and platforms — no rankings paid for.