Repository files navigation

A simple Github template that lets you create anAndroid/Kotlin project and be up and running in afew seconds.

This template is focused on delivering a project withstatic analysis andcontinuous integration already in place.

Just click on button to create a new repo starting from this template.

Once created don't forget to update the:

• App ID
• AndroidManifest (here andhere)
• Package of the source files

• 100% Kotlin-only template.
• 3 Sample modules (Android app, Android library, Kotlin library).
• Sample Espresso, Instrumentation & JUnit tests.
• 100% Gradle Kotlin DSL setup.
• Dependency versions managed viabuildSrc.
• CI Setup with GitHub Actions.
• Kotlin Static Analysis viaktlint anddetekt.
• Publishing Ready.
• Issues Template (bug report + feature request)
• Pull Request Template.

This template is usingGradle Kotlin DSL as well as thePlugin DSL to setup the build.

Dependencies are centralized inside theDependencies.kt file in thebuildSrc folder. This provides convenient auto-completion when writing your gradle files.

This template is usingktlint with thektlint-gradle plugin to format your code. To reformat all the source code as well as the buildscript you can run thektlintFormat gradle task.

This template is also usingdetekt to analyze the source code, with the configuration that is stored in thedetekt.yml file (the file has been generated with thedetektGenerateConfig task).

This template is usingGitHub 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 thebuild,check andpublishToMavenLocal tasks.

The template is setup to beready to publish a library/artifact on a Maven Repository. If you're using JitPack, you don't need any further configuration and you can just configure the repo on JitPack. If you're using another repository (MavenCentral/JCenter/etc.), you need to specify the publishing coordinates.

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