kotlin-android-library-template 🤖

A simple Github template that lets you create an Android/Kotlin library.

Forked from cortinico/kotlin-android-template.

Features

• 100% Kotlin-only template.
• 3 Sample modules (Android app, Android library, Kotlin library).
• 100% Gradle Kotlin DSL setup.
• Dependency versions managed via versions.properties.
• CI Setup with GitHub Actions.
• Deploy website and docs.
• Kotlin Static Analysis via detekt.
• Publishing Ready.
• Issues Template (bug report + feature request)
• Pull Request Template.

Gradle Setup

This template is using Gradle Kotlin DSL as well as the Plugin DSL to setup the build.

Dependencies are centralized inside the versions.properties managed by RefreshVersions.

To check the newest version of dependencies you can run ./gradlew refreshVersions.

Static Analysis

This template is using detekt to analyze the source code, with the configuration that is stored in the detekt.yml file.

To reformat all the source code as well as the buildscript you can run ./gradlew detektFormat.

CI

This template is using GitHub Actions as CI.

Docs

This template deploy the website to the Github Pages via Material for MkDocs and Dokka.

Publishing

The template is setup to be ready to publish a library/artifact on a Maven Repository via gradle-maven-publish-plugin.

See publish configuration in gradle.properties.

Contributing

Feel free to open a issue or submit a pull request for any bugs/improvements.