Overview

Slate Kit comes with a command line executable to serve as a project generator. This is simply a Kotlin executable jar packaged as a Java Application via gradle that can be executed on the command line with bash/batch scripts. A quick example is below:

    
    slatekit new app -name="Sample1" -package="mycompany.apps"

Index

Table of contents for this page

Section	Component	Description
1	Status	Current status of this component
2	Install	Installation instructions and references to sources
3	Requires	Lists all the Slate Kit and third-party dependencies
4	APP	Generate a new console application
5	API	Generate a new HTTP API
6	CLI	Generate a new console CLI (command line interface) application
7	JOB	Generate a new backgroun job
8	LIB	Generate a new reusable library
9	ORM	Generate a new Domain Driven Database/Entites/ORM project
10	Custom	Create custom templates
11	Help	More info and help on the generators

Status

This component is currently stable and there is a project generator for it ( see below ).
A small future enhancement will optionally add support for Docker and gradle Docker configuration.
Back to top

Install

You can install the slatekit application/command line tool from slatekit

    // For mac,nix
    slatekit
    
    // For windows
    slatekit.bat 

    slatekit -version
    slatekit -help

APP

The Slate App is a base application and template to build console, batch, cli and server applications. It has pre-built support for common features such as command line args, environment selection, configs per environment, logging, life-cycle events, diagnostics and much more. You can create a app quickly using the Slate Kit command line executable with the following inputs. Also refer to the Example_App.kt.

    
    slatekit new app -name="Sample1" -package="mycompany.apps"

API

    
    slatekit new api -name="Sample1" -package="mycompany.apps"

CLI

    
    slatekit new cli -name="Sample1" -package="mycompany.apps"

JOB

    
    slatekit new job -name="Sample1" -package="mycompany.apps"

LIB

    
    slatekit new job -name="Sample1" -package="mycompany.apps"

ORM

    
    slatekit new orm -name="Sample1" -package="mycompany.apps"

Custom

The command line generator can be extended with custom templates. You have to create various configuration files and instructions similar to the existing ones. Refer to a sample configuration for the App for more info

    
    slatekit new my_service_template -name="Service1" -package="mycompany.services"

Help

You can also get help on the command for each project type. Run the following commands

    
    slatekit new app -help
    slatekit new api -help
    slatekit new cli -help
    slatekit new job -help
    slatekit new lib -help
    slatekit new orm -help

Generators