adrianalonso/kotlin-examples

Kotlin Bootstrap (base / project skeleton)

Introduction

This is a repository intended to serve as a starting point if you want to bootstrap a project in Kotlin.

It could be useful if you want to start from scratch a kata or a little exercise or project. The idea is that you don't have to worry about the boilerplate

• Latest stable kotlin version
• Best practices applied:
  • README.md
  • LICENSE
  • build.gradle.kts
  • .gitignore
• Some useful resources to start coding

How To Start

You could manually clone this repo or just us it as a template

Cloning the repository

We recommend to follow the next step by step process in order to avoid adding the bootstrap project commits to your project Git history:

1. Use this repositoy template
2. Clone your project
3. Move to the project directory: cd your-project-name
4. Build the project for the first time: ./gradlew build
5. Run all the checks: ./gradlew check. This will do some checks that you can perform with isolated commands:
   1. Klint using Spotless: ./gradlew spotlessCheck. If you want to fix style issues automatically: ./gradlew spotlessApply.
   2. Kotlin test: ./gradlew test.
6. To just run the project execute: ./gradlew run
7. Start coding!

Helpful resources

Kotlin

• Kotlin Coding Conventions
• Comparison between Kotlin and Java

Kotlin test

• Test code using JUnit in JVM - tutorial
• JUnit5 assertions

About

This hopefully helpful utility has been developed by CodelyTV and contributors.

We'll try to maintain this project as simple as possible, but Pull Requests are welcome!

License

The MIT License (MIT). Please see License File for more information.