Getting Started

Maven Archetypes

linkki can be used for a plain Vaadin web application or with Spring Boot. For each of those options, there is a matching Maven archetype that creates a new project with all necessary dependencies and some sample code to get started. They can be created from a command line.

Plain linkki

Command to execute the archetype
mvn archetype:generate -DarchetypeGroupId=org.linkki-framework.archetypes -DarchetypeArtifactId=linkki-archetype-plain-application-vaadin-flow -DarchetypeVersion=2.5.2

The resulting application can be deployed to your application server of choice or simply started with mvn clean package org.eclipse.jetty:jetty-maven-plugin:run, where it can be viewed at http://localhost:8080/.

linkki with Spring Boot

Command to execute the archetype
mvn archetype:generate -DarchetypeGroupId=org.linkki-framework.archetypes -DarchetypeArtifactId=linkki-archetype-spring-application-vaadin-flow -DarchetypeVersion=2.5.2

For the seamless operation of applications built using the Spring Archetype, adherence to the proper startup procedures is recommended:

Development mode

After packaging, use mvn spring-boot:run to start the application.

mvn package
mvn spring-boot:run
Production mode

Ensure you package with the profile production, then start the application using java -jar target/*.jar.

mvn package -Pproduction
java -jar target/App.jar

The application can then be viewed at http://localhost:8080/