Ready to kick off your next Android project? This template will get you started as quick as possible with a lot of interesting features, so you can focus directly on your application.
- 100% Kotlin-only template. ✔️
- Jetpack Compose setup ready to use. ✔️
- Dagger Hilt, Retrofit, OkHttp, Room ✔️
- Sample Espresso, Instrumentation & JUnit tests. ✔️
- 100% Gradle Kotlin DSL setup. ✔️
- CI Setup with GitHub Actions. ✔️
- Dependency versions managed via
buildSrc. ✔️ - Kotlin Static Analysis via
detektandktlint. ✔️ - Issues Template (bug report + feature request). ✔️
- Pull Request Template. ✔️
This template is using Gradle Kotlin DSL as well as the Plugin DSL to setup the build.
Dependencies are centralized inside the Gradle Version Catalog in the libs.versions.toml file in the gradle folder.
This template is using detekt to analyze the source code, with the configuration that is stored in the detekt.yml file (the file has been generated with the detektGenerateConfig task). It also uses the detekt-formatting plugin which includes the ktlint rules (see https://detekt.dev/docs/rules/formatting/).
This template is using GitHub Actions as CI. You don't need to setup any external service and you should have a running CI once you start using this template.
There are currently the following workflows available:
- Validate Gradle Wrapper - Will check that the gradle wrapper has a valid checksum
- Pre Merge Checks - Will run the
build,checktasks.
app: The source for the final Android application.
The following additional top-level directories configure & support building the app & projects:
buildSrc: Contains shared Gradle logic as precompiled script pluginsconfig: Contains the Detekt configuration file.gradle: Contains Gradle Configuration files such as the Gradle Version Catalog and the Gradle Wrapper.
Finally, the following hidden top-level directories provide functionality for specific development systems:
.github: Defines the Github Actions CI tasks and templates for new pull requests, issues, etc..idea: Sets common initial project settings when the project is opened in Android Studio or IntelliJ IDEA.
Feel free to open a issue or submit a pull request for any bugs/improvements.