Skip to content

felipecsl/kales

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kales

A modern web framework built for developer productivity and safety.
Kales runs on top of Ktor and uses an MVC architecture.

Usage

Run the following in your terminal, then follow the onscreen instructions.

curl https://raw.githubusercontent.com/felipecsl/kales/master/scripts/install -sSf | sh

This will install the command line application kales. It can generate the boilerplate you need to bootstrap a new web app.

Running the example app

./gradlew sampleapp:run

then open http://localhost:8080 on your browser.

Hot reloading

Ktor supports hot reloading out of the box, simply open a new terminal window and run:

./gradlew -t sampleapp:jar

Deploying the docs website

$ ./gradlew dokka # Regenerate the API docs
$ cd website
$ GIT_USER=felipecsl \
 CURRENT_BRANCH=master \
 USE_SSH=true \
 yarn run publish-gh-pages

and it will automatically rebuild as you make new changes.

Download

implementation 'com.felipecsl.kales:kales:0.0.7-SNAPSHOT'

Snapshots of the development version are available in Sonatype's snapshots repository.

Usage

Check the sampleapp directory for an application that uses some of the features exposed by Kales.

For more information, please check the Kales website.