jungwoohyoen / android-gradle-kotlin-dsl-starter

:dash:ㅤAndroid gradle kotlin dsl starter template project. 안드로이드 Kotlin DSL 템플릿 제공

Android Gradle Kotlin DSL Starter (Kotlin DSL Template)

Android Gradle Kotlin DSL Starter provides a simple template for those who want to start a project with the Kotlin DSL.

Getting Started

Android Gradle Kotlin DSL Starter is a template that you can use when setting up your first android project. Also, this template is focused on delivering a project with static analysis and continuous integration already in place.

Features

• 100% Kotlin-only template.
• 100% Gradle Kotlin DSL setup.
• Dependency versions managed via buildSrc.
• Kotlin Static Analysis via ktlint and detekt.
• Git Setup with Git-Hooks.

Installation

1. Create a new repo starting from this template using button.
2. Update APPLICATION_ID and BUILD_FILE_PREFIX according to your project.
3. Update the package name and label of AndroidManifest to suit your project.
4. Update package of the all source files

Environment setup

Some default settings are required to use the project.

Keystore

• Create keystore folder in project root.
• Create keystore.properties and key files for debug and release in the created keystore folder.

# Signing Config
# release
release.signing.key.alias=<insert>
release.signing.key.password=<insert>
release.signing.store.file=<insert> (../keystore/xxxxxxx.jks or .keystore)
release.signing.store.password=<insert>
# debug
debug.signing.key.alias=<insert>
debug.signing.key.password=<insert>
debug.signing.store.file=<insert> (../keystore/xxxxxxx.jks or .keystore)
debug.signing.store.password=<insert>

Coding Standards

To maintain the style and quality of the code, are used the bellow static analysis tools. All of them use properly configuration and you find them in the project root directory .{toolName}.

Tools	Config file	Check command	Fix command
detekt	/.detekt	./gradlew detekt	-
ktlint	-	./gradlew ktlintCheck	./gradlew ktlintFormat
lint	/.lint	./gradlew lint	-

All of the above tests can be run with ./gradlew check, which is used through Git-Hooks below. If you need to modify your coding standards, please refer to .editorconfig

Git-Hooks

When the project build is complete, git hooks related copyGitHooks, deleteGitHooks, and installGitHooks tasks will be created. When you run the installGitHooks task, pre-push hooks are installed, and from then on, push is performed only if there is no problem by performing ./gradlew check before being pushed to git.

License

Android Gradle Kotlin DSL Starter is under MIT license. See the LICENSE for more info.