Kotlin Starters

Common Gradle project templates with emphasis on Kotlin, separated by target platform and kind of distribution.

	Plugins	Testing	Publishing	Website	Coverage	Max Heap Size
android-app	Kotlin Android, Android	JUnit 4, Robolectric	✗	Cayman	✓	4GB
android-library	Kotlin Android, Android	JUnit 4, Robolectric	Maven Central	Dokka, Minimal	✓	4GB
gradle-plugin	Kotlin DSL	JUnit 4	Plugin Portal	Dokka, Minimal	✗	2GB
js-app	✗	✗	✗	Cayman	✓	2GB
jvm-app	Kotlin JVM, Application	JUnit 5	✗	Cayman	✓	2GB
jvm-library	Kotlin JVM	JUnit 5	Maven Central	Dokka, Minimal	✓	2GB
native-app	✗	✗	✗	Cayman	✓	2GB

Frameworks

• Targeted plugin for each platform and Coroutines Support Library.
• JUnit testing framework with Kotlin Test library support, Mockito suite and Truth asserter.
• Ktlint code linter with third-party ruleset Rulebook.
• Kover code coverage.

Project layout

• Root directory:
  • GitHub README, LICENSE, and gitignore file.
  • EditorConfig enforces IDE settings.
  • CircleCI to run test every commit, also triggers Codecov integration within CircleCI.
• Gradle build tool:
  • Kotlin DSL scripts with properties delegation.
  • Apply plugin using plugins DSL.
  • Version catalogs in TOML file to avoid typing unsafe dependencies.
• Website module:
  • Pages Gradle Plugin for generating webpage displaying README's content and documentation links.
  • gradle-git-publish plugin, necessary for uploading to GitHub Pages.