Skip to content

Commit d8ea06a

Browse files
author
Isabel Garrido
committed
Add README
1 parent db52983 commit d8ea06a

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Kotlin Bootstrap (base / project skeleton)
2+
3+
[![Software License][ico-license]][link-license]
4+
5+
## Introduction
6+
7+
This is a repository intended to serve as a starting point if you want to bootstrap a project in Kotlin.
8+
9+
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
10+
* Latest stable kotlin version
11+
* Best practices applied:
12+
* [`README.md`][link-readme]
13+
* [`LICENSE`][link-license]
14+
* [`build.gradle.kts`][link-build-gradle]
15+
* [`.gitignore`][link-gitignore]
16+
* Some useful resources to start coding
17+
18+
## How To Start
19+
20+
You just need to manually clone [this repo](https://github.com/CodelyTV/kotlin-basic-skeleton)
21+
22+
### Cloning the repository
23+
24+
We recommend to follow the next step by step process in order to avoid adding the bootstrap project commits to your project Git history:
25+
26+
1. [Use this repositoy template](https://github.com/CodelyTV/kotlin-basic-skeleton/generate)
27+
2. Clone your project
28+
3. Move to the project directory: `cd your-project-name`
29+
5. Build the project for the first time: `./gradlew build`
30+
6. Run all the checks: `./gradlew check`. This will do some checks that you can perform with isolated commands:
31+
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`.
32+
2. [Kotlin test](https://kotlinlang.org/api/latest/kotlin.test/): `./gradlew test`.
33+
7. Start coding!
34+
35+
## Helpful resources
36+
37+
### Kotlin
38+
39+
* [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html)
40+
* [Comparison between Kotlin and Java](https://kotlinlang.org/docs/comparison-to-java.html)
41+
42+
### Kotlin test
43+
44+
* [Test code using JUnit in JVM - tutorial](https://kotlinlang.org/docs/jvm-test-using-junit.html)
45+
* [JUnit5 assertions](https://junit.org/junit5/docs/5.0.1/api/org/junit/jupiter/api/Assertions.html)
46+
47+
48+
## About
49+
50+
This hopefully helpful utility has been developed by [CodelyTV][link-author] and [contributors][link-contributors].
51+
52+
We'll try to maintain this project as simple as possible, but Pull Requests are welcomed!
53+
54+
## License
55+
56+
The MIT License (MIT). Please see [License File][link-license] for more information.
57+
58+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
59+
60+
[link-license]: LICENSE
61+
[link-readme]: README.md
62+
[link-gitignore]: .gitignore
63+
[link-build-gradle]: build.gradle.kts
64+
[link-author]: https://github.com/CodelyTV

0 commit comments

Comments
 (0)