README.md

Vert.x + Kotlin (w/ coroutines) boilerplate 🛠

Prerequisites

• Make sure you have JAVA installed
• Install SDKMAN
• Install Kotlin lang using SDKMAN
• Install Gradle using SDKMAN

How to run:

• Clone the repo: git clone https://github.com/kanzitelli/kotlin-vertx-boilerplate.git
• Rename the folder if needed: mv kotlin-vertx-boilerplate new_name (note: if you want to rename the package then it would be safer to do it directly in the IntelliJ Idea)
• $ cd new_name/
• $ gradle build
• $ gradle run
• or to build a Jar and run in production mode

$ gradle shadowJar
$ java -jar build/libs/app-shadow.jar

Heroku deployment

• $ heroku login
• $ heroku create
• $ git push heroku master
• $ heroku open
• NOTE: Don't forget to go to Heroku dashboard → your app → Settings, and then add Config Vars:
  • PORT=80
  • HOST=https://your-app-name.herokuapp.com

For more information check this link.

API ENDPOINTS

• /home{.json} - returns json with information gathered from this link with current time added to JSON response.
• /hello{.json} - returns json with simple message { message: "Hello, World!" }.
• /todos - simple local (data stored in an array) implementation of todos CRUD actions .

What's included:

• Building a Web application on top of Vert.x
• Kotlin coroutines 🎉
• Querying remote services with the Retrofit2 (+ Kotlin coroutines await() for Retrofit2 Call)
• Using Gradle for enabling efficient workflow
• Manipulating JSON with Kotson
• Logging with Logback