hanggrian/kotlin-starters

Personal Kotlin project templates

Kotlin Starters

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

	Plugins	Publication	Testing
android-app	Android	✗	Robolectric
android-library	Android, Dokka	Maven Central	Robolectric
js-app	✗	✗	✗
jvm-app	Application	✗	✗
jvm-library	Dokka	Maven Central	✗
native-app	✗	✗	✗

Kotlin Frameworks

• Targeted plugin for each platform and Coroutines Support Library.
• Kotlin Test Library with JUnit dependencies.
• 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 (except for apps).
  • gradle-git-publish plugin, necessary for uploading to GitHub Pages.