

Getting Started¶

Using the Boilerplate (Recommended)¶

The fastest way to get started is to clone the krews-boilerplate. This is not only quick, but is set up using what we consider to be best practices.

The boilerplate README.md contains instructions on what you’ll need to replace, as well as instructions on running and building.

If you’re an advanced user and would like to setup your own Krews Application project from scratch, start by setting up a Kotlin project.

Instructions on setting up Kotlin projects can be found here.

You can get the Krews library using any Maven compatible build system

dependencies {
    compile("io.krews", "krews", "0.7.0")
}

<dependency>
  <groupId>io.krews</groupId>
  <artifactId>krews</artifactId>
  <version>0.7.0</version>
</dependency>

We recommend that you build the application into an executable Jar.

On Gradle, this can be done using the Shadow Plugin

On Maven, this can be done using the Shade Plugin

If you’d like to use your project as a library to be referenced in other projects / workflows, you’ll need to also create a sources Jar.

Publishing your Jars to a Maven Repository like Bintray will give you a free (for open source) place to store your libraries and executables.