Welcome to Kmmify, a streamlined template to kickstart your Kotlin Multiplatform projects. This template provides a foundation for building cross-platform applications sharing business logic across iOS, Android, and Web platforms while allowing for platform-specific implementations.

• Multiplatform project setup for Android, iOS, and Web
• Pre-configured Gradle scripts for building and testing
• Documentation ready with MkDocs
• Code analysis setup with Detekt

Ensure you have the following installed:

• JDK 1.8 or newer
• Kotlin Multiplatform compatible IDE (IntelliJ IDEA recommended)
• Gradle 7.0 or newer

Clone the repository:

git clone https://github.com/goatbytes/kmmify.git
cd kmmify

Build the project using Gradle:

./gradlew build

To run Detekt for static code analysis:

./gradlew detektAll

Generate project documentation using Dokka:

./gradlew dokkaHtml

To view the documentation locally, first ensure you have MkDocs installed:

pip install mkdocs

Then serve the documentation:

mkdocs serve

Ensure you have the appropriate permissions and your GitHub Token is set up. Then, run:

./gradlew publish

To sign your artifacts before publishing, ensure the following properties are set in your gradle.properties or passed via environment variables:

• SIGNING_KEY_ID
• SIGNING_KEYRING
• SIGNING_PASSWORD

Contributions are welcome! Please read our contributing guide and submit pull requests to our repository.

Distributed under the Apache v2.0 License. See LICENSE.txt for more information.

At GoatBytes.IO, our mission is to develop secure software solutions that empower businesses to transform the world. With a focus on innovation and excellence, we strive to deliver cutting-edge products that meet the evolving needs of businesses across various industries.