Start

Overview

Slate Kit is built in 100% Kotlin and depends on Java. The Slate Kit 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 Slate Kit 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 Slate Kit 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/slatekit
    brew install slatekit
    



Create

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

argscommand line args ( -env=dev )
envsenvironments ( local, dev, qat, uat, pro )
confsconfiguration files ( per environment and inheritable from a base config )
logslogging support ( using logback )
helphelp usage and more

This is just 1 type of project you can create.

    
    # Generate new app ( into current directory )
    :> slatekit 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.

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


Samples

There are also several sample applications available in git at Samples