https://github.com/codelytv/kotlin-basic-skeleton

A basic Skeleton to create your Kotlin apps easily
https://github.com/codelytv/kotlin-basic-skeleton

bootstrap kotlin kotlin-library

Last synced: 4 days ago
JSON representation

A basic Skeleton to create your Kotlin apps easily

• Host: GitHub
• URL: https://github.com/codelytv/kotlin-basic-skeleton
• Owner: CodelyTV
• Created: 2021-07-02T14:31:40.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-27T09:02:26.000Z (12 months ago)
• Last Synced: 2024-05-01T09:38:42.698Z (7 months ago)
• Topics: bootstrap, kotlin, kotlin-library
• Language: Kotlin
• Homepage:
• Size: 121 KB
• Stars: 50
• Watchers: 5
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kotlin Bootstrap (base / project skeleton)

[![Software License][ico-license]][link-license]

## 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`][link-readme]

    * [`LICENSE`][link-license]

    * [`build.gradle.kts`][link-build-gradle]

    * [`.gitignore`][link-gitignore]

* Some useful resources to start coding

## How To Start

You could manually clone [this repo](https://github.com/CodelyTV/kotlin-basic-skeleton) 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](https://github.com/CodelyTV/kotlin-basic-skeleton/generate)

2. Clone your project

3. Move to the project directory: `cd your-project-name`

5. Build the project for the first time: `./gradlew build`

6. Run all the checks: `./gradlew check`. This will do some checks that you can perform with isolated commands:

    1. [Klint](https://ktlint.github.io/) using [Spotless](https://github.com/diffplug/spotless): `./gradlew spotlessCheck`. If you want to fix style issues automatically: `./gradlew spotlessApply`.

    2. [Kotlin test](https://kotlinlang.org/api/latest/kotlin.test/): `./gradlew test`.

7. To just run the project execute: `./gradlew run`

7. Start coding!

## Helpful resources

### Kotlin

* [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html)

* [Comparison between Kotlin and Java](https://kotlinlang.org/docs/comparison-to-java.html)

### Kotlin test

* [Test code using JUnit in JVM - tutorial](https://kotlinlang.org/docs/jvm-test-using-junit.html)

* [JUnit5 assertions](https://junit.org/junit5/docs/5.0.1/api/org/junit/jupiter/api/Assertions.html)

## About

This hopefully helpful utility has been developed by [CodelyTV][link-author] and [contributors][link-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][link-license] for more information.

[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square

[link-license]: LICENSE

[link-readme]: README.md

[link-gitignore]: .gitignore

[link-build-gradle]: build.gradle.kts

[link-author]: https://github.com/CodelyTV

[link-contributors]: https://github.com/CodelyTV/kotlin-basic-skeleton/graphs/contributors