https://github.com/mvysny/karibu8-helloworld-application-maven

Karibu-DSL HelloWorld Application with Maven
https://github.com/mvysny/karibu8-helloworld-application-maven

Last synced: 15 days ago
JSON representation

Karibu-DSL HelloWorld Application with Maven

• Host: GitHub
• URL: https://github.com/mvysny/karibu8-helloworld-application-maven
• Owner: mvysny
• License: mit
• Created: 2017-07-14T12:17:31.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-10-13T18:58:25.000Z (about 3 years ago)
• Last Synced: 2024-10-24T02:26:40.757Z (20 days ago)
• Language: Kotlin
• Homepage: https://github.com/mvysny/karibu-dsl
• Size: 115 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Powered By Vaadin on Kotlin](http://vaadinonkotlin.eu/iconography/vok_badge.svg)](http://vaadinonkotlin.eu)

Karibu-DSL Hello World Application

==================================

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

This is the Vaadin application as generated from [https://vaadin.com/maven](https://vaadin.com/maven), but converted

to Kotlin by using the [Karibu-DSL](https://github.com/mvysny/karibu-dsl) framework.

For newest Vaadin version please see the [Vaadin Framework Github Tags](https://github.com/vaadin/framework/tags) page.

Workflow

========

To compile the entire project, run `./mvnw -C clean package` (or on Windows: `./mvnw.cmd -C clean package`).

To run the application, run `./mvnw jetty:run` and open http://localhost:8080/ .

To produce a deployable production mode WAR:

- change productionMode to true in the servlet class configuration (nested in the UI class)

- run "mvn clean package"

- test the war file with "mvn jetty:run-war"

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

  - 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, open pom.xml and comment out the compile-theme 

goal from vaadin-maven-plugin configuration. To remove a possibly existing 

pre-compiled theme, run "mvn clean package" once.

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.

Using Vaadin pre-releases

-------------------------

If Vaadin pre-releases are not enabled by default, use the Maven parameter

"-P vaadin-prerelease" or change the activation default value of the profile in pom.xml .