https://github.com/initishbhatt/android-kotlin-compose-template

Android + Kotlin + Compose + KtLint + spotless + Gradle kotlin DSL
https://github.com/initishbhatt/android-kotlin-compose-template

android android-app android-template gradle-kotlin-dsl jetpack jetpack-android jetpack-compose jetpack-compose-testing kotlin kotlin-android kotlin-dsl-plugin ktlint spotless template template-repository

Last synced: 3 months ago
JSON representation

Android + Kotlin + Compose + KtLint + spotless + Gradle kotlin DSL

• Host: GitHub
• URL: https://github.com/initishbhatt/android-kotlin-compose-template
• Owner: initishbhatt
• License: mit
• Created: 2021-03-15T14:11:32.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-03-14T06:23:03.000Z (almost 3 years ago)
• Last Synced: 2024-01-17T00:16:04.322Z (about 1 year ago)
• Topics: android, android-app, android-template, gradle-kotlin-dsl, jetpack, jetpack-android, jetpack-compose, jetpack-compose-testing, kotlin, kotlin-android, kotlin-dsl-plugin, ktlint, spotless, template, template-repository
• Language: Kotlin
• Homepage:
• Size: 116 KB
• Stars: 2
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kotlin-android-compose-template

![Workflow result](https://github.com/initishbhatt/android-kotlin-compose-template/workflows/pr_merge/badge.svg)

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 [![Use this template](https://img.shields.io/badge/use-this%20tempate-yellowgreen)](https://github.com/initishbhatt/android-kotlin-compose-template/generate) button.

Clone your repository and open it in the latest [Android Studio (Canary build)](https://developer.android.com/studio/preview).

Once created don't forget to update the:

- [Application Id](buildSrc/src/main/java/Dependencies.kt)

- [AndroidManifest](app/src/main/AndroidManifest.xml)

- **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**](https://docs.gradle.org/current/userguide/kotlin_dsl.html)

Dependencies are placed inside the [Dependencies.kt](buildSrc/src/main/java/Dependencies.kt) file in the `buildSrc` folder inspired by [Jetcaster](https://github.com/android/compose-samples/tree/main/Jetcaster)

## Static Analysis

This template is using [**ktlint**](https://github.com/pinterest/ktlint) with the [**spotless**](https://github.com/diffplug/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.