Start

Overview

Kiit is built in 100% Kotlin and depends on Java. The Kiit CLI generates new projects using the Gradle build tool.
If you are new to Kotlin, refer to Kotlin for more info.

Required

Installation of Java, Kotlin, Gradle and Kiit is fairly easy. We recommend the following installation steps and centralized location for simplicity.

Tech	Required	Version	Instructions
Java	Required	>= 8	https://www.java.com/en/download/help/download_options.html
Gradle	Required	>= 6.7	https://gradle.org/install/
IntelliJ	Recommended	>= 2020.2	https://www.jetbrains.com/idea/

CLI

The Kiit CLI is a command line tool ( based on HomeBrew on Mac OS ) that can be used to create projects

     
    # Note: install may take a while on Mac OS Catalina 
    # See notes/issues below

    brew tap slatekit/kiit
    brew install kiit

You may experience some issues with the install, consider the following
1: Ensure System Preferences -> security -> privacy -> full disk access -> iterm2 ( of what ever terminal you use )
2: Slow HomeBrew post install on Mac OS Catalina ( based on thread below )
3: The install may be very slow with MacOS Catalina

You can download the Slate Kit Project Generator at slatekit-cli.
Install instructions located at Generators.

Create

You can create your first app by running the command below which will create a new console application with support for :

args	command line args ( -env=dev )
envs	environments ( local, dev, qat, uat, pro )
confs	configuration files ( per environment and inheritable from a base config )
logs	logging support ( using logback )
help	help usage and more

This is just 1 type of project you can create.

    
    # Generate new app ( into current directory )
    :> kiit new app -name="Sample1" -packageName="mycompany.apps"

    #  navigate into the generated app 
    :> cd Sample1

    # Build and run
    :> gradle run

Generators

You can create several different project types using the generator, these include CLIs, APIs, Jobs, and more to come.

    
    kiit new app -name="SampleApp1" -packageName="company1.apps"
    kiit new api -name="SampleAPI1" -packageName="company1.apis"
    kiit new cli -name="SampleCLI1" -packageName="company1.apps"
    kiit new job -name="SampleJob1" -packageName="company1.jobs"
    kiit new env -name="SampleApp2" -packageName="company1.apps"

Tip: See the Generators page for more info on using the Kiit CLI tool and info on the project types.

Samples

There are also several sample applications available in git at Samples

The Generators are based on these Sample projects which are kept up to date with latest releases.

Apps

There are various runnable application types you can create with Kiit. See the links below for more docs and guides on how to get started with them.

App	Server	Runnable App Template
CLI	Server	Command Line Interface
Server	Server	Http Server ( using Ktor ) and our Universal APIs
API	Server / Console	Universal APIs
Jobs	Android / Server	Pausable Background jobs/queues library