Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mvysny/vok-helloword-app-jpa

A very simple Vaadin-on-Kotlin HelloWorld app which you start off when building your own apps
https://github.com/mvysny/vok-helloword-app-jpa

Last synced: 15 days ago
JSON representation

A very simple Vaadin-on-Kotlin HelloWorld app which you start off when building your own apps

Awesome Lists containing this project

README 

        
[![Build Status](https://travis-ci.org/mvysny/vok-helloword-app-jpa.svg?branch=master)](https://travis-ci.org/mvysny/vok-helloword-app-jpa)



# Vaadin-on-Kotlin Example App / Archetype



Template for a simple Vaadin-on-Kotlin application that only requires a Servlet 3.0 container to run.

Just clone this repo and start building your awesome app!



To start creating your app, just follow the [Getting Started tutorial](http://www.vaadinonkotlin.eu/gettingstartedjpa.html).



Note: this example app uses JPA. It is recommended to use the [Vaadin-on-Kotlin Example App Sql2o](https://github.com/mvysny/vok-helloword-app) instead since it's way simpler



# Getting Started



To quickly start the app, make sure that you have Java 8 JDK installed. Then, just type this into your terminal:



```bash

git clone https://github.com/mvysny/vok-helloword-app-jpa

cd vok-helloworld-app

./gradlew build web:appRun

```



The app will be running on http://localhost:8080/



## The 'complete' sources



You can switch the git branch from 'master' to ['complete'](../../tree/complete), to see the outcome application of the

[Vaadin-on-Kotlin Getting Started](http://www.vaadinonkotlin.eu/gettingstartedjpa.html) tutorial. 



# Workflow



To compile the entire project, run `./gradlew`.



To run the application, run `./gradlew web:appRun` (run the `appRun` task in the `web` Gradle module) and open http://localhost:8080/ .



To produce a deployable production mode WAR:

- change `productionMode` to `true` in the servlet class configuration (located in the [MyUI.kt](web/src/main/kotlin/com/example/vok/MyUI.kt) file)

- run `./gradlew`

- You will find the WAR file in `web/build/libs/web.war`



This will allow you to quickly start the example app and allow you to do some basic modifications.

For real development we recommend Intellij IDEA Ultimate, please see below for instructions.



## Client-Side compilation



The generated maven project is using an automatically generated widgetset by default. 

When you add a dependency that needs client-side compilation, the maven plugin will 

automatically generate it for you. Your own client-side customisations can be added into

package "client".



Debugging client side code  @todo revisit with Gradle

  - run "mvn vaadin:run-codeserver" on a separate console while the application is running

  - activate Super Dev Mode in the debug window of the application



## Developing a theme using the runtime compiler



When developing the theme, Vaadin can be configured to compile the SASS based

theme at runtime in the server. This way you can just modify the scss files in

your IDE and reload the browser to see changes.



To use the runtime compilation, run `./gradlew clean appRun`. Gretty will automatically

pick up changes in theme files and Vaadin will automatically compile the theme on

browser refresh. You will just have to give Gretty some time (one second) to register

the change.



When using the runtime compiler, running the application in the "run" mode 

(rather than in "debug" mode) can speed up consecutive theme compilations

significantly.



It is highly recommended to disable runtime compilation for production WAR files.



# Development with Intellij IDEA Ultimate



The easiest way (and the recommended way) to develop Karibu-DSL-based web applications is to use Intellij IDEA Ultimate.

It includes support for launching your project in any servlet container (Tomcat is recommended)

and allows you to debug the code, modify the code and hot-redeploy the code into the running Tomcat

instance, without having to restart Tomcat.



1. First, download Tomcat and register it into your Intellij IDEA properly: https://www.jetbrains.com/help/idea/2017.1/defining-application-servers-in-intellij-idea.html

2. Then just open this project in Intellij, simply by selecting `File / Open...` and click on the

   `build.gradle` file. When asked, select "Open as Project".

2. You can then create a launch configuration which will launch the `web` module as `exploded` in Tomcat with Intellij: just

   scroll to the end of this tutorial: https://kotlinlang.org/docs/tutorials/httpservlets.html

3. Start your newly created launch configuration in Debug mode. This way, you can modify the code

   and press `Ctrl+F9` to hot-redeploy the code. This only redeploys java code though, to

   redeploy resources just press `Ctrl+F10` and select "Update classes and resources"