kotlin-android-compose-template

A simple Github template to create an Android/Kotlin, Compose ready project.

A major chunk of development time is taken up by setting up DSL, static analysis and CI. This template is made with an aim to reduce this redundant work and be ready with a working repository where all these are handled.

How to use

Copy this repository by pressing the button. Clone your repository and open it in the latest Android Studio (Canary build).

Once created don't forget to update the:

• Application Id
• AndroidManifest
• Package of the source files

Features

• Kotlin-only template.
• Compose-Ready
• Gradle Kotlin DSL setup.
• Dependency versions managed via buildSrc.
• Sample Compose Test.
• Kotlin Static Analysis via ktlint.
• Spotless for code formatting.
• CI Setup with GitHub Actions.
• Issues Template (bug report + feature request).
• Pull Request Template.

Gradle Setup

This template uses Gradle Kotlin DSL

Dependencies are placed inside the Dependencies.kt file in the buildSrc folder inspired by Jetcaster

Static Analysis

This template is using ktlint with the spotless plugin to format your code. Run ./gradlew app:spotlessApply to automatically format your code.

Contributing

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