Kotlin Base Project Setup

A simple Github template that lets you create an Kotlin project and be up and running in a few seconds.

This template is focused on delivering a project with static analysis and continuous integration already in place.

Features 🦄

• 100% Kotlin-only template.
• Kotlin K2 Compiler.
• Examples of JUnit5 tests.
• 100% Gradle Kotlin DSL setup.
• CI Setup with GitHub Actions.
• Aggressive Kotlin Static Analysis via detekt, ktlint, diktat and spotless.
• Issues Template (bug report + feature request).
• Documentation Engine for Kotlin via dokka

Contributing 🤝

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

detekt

Metrics

• 3 number of properties

• 14 number of functions

• 3 number of classes

• 1 number of packages

• 3 number of kt files

Complexity Report

• 190 lines of code (loc)

• 102 source lines of code (sloc)

• 67 logical lines of code (lloc)

• 63 comment lines of code (cloc)

• 15 cyclomatic complexity (mcc)

• 2 cognitive complexity

• 0 number of total code smells

• 61% comment source ratio

• 223 mcc per 1,000 lloc

• 0 code smells per 1,000 lloc

Findings (0)

generated with detekt version 1.23.6 on 2024-09-18 21:00:45 UTC

License

Designed and developed by 2024 ashtanko (Oleksii Shtanko)

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.