Getting Started

You can either add the required dependencies to an existing project or use one of the Maven archetypes to get started.

Maven dependencies

To create a linkki project with Vaadin 8, you need one of the following dependencies depending on the feature set you need:

linkki-core
            <dependency>
                <groupId>org.linkki-framework</groupId>
                <artifactId>linkki-core-vaadin8</artifactId>
                <version>1.4.8</version>
            </dependency>
linkki-application-framework
            <dependency>
                <groupId>org.linkki-framework</groupId>
                <artifactId>linkki-application-framework-vaadin8</artifactId>
                <version>1.4.8</version>
            </dependency>

linkki-application-framework contains the following additional features:

  • Dialogs

  • Sidebar sheets

  • LinkkiUi with ApplicationLayout and ApplicationConfig as well as an adjusted theme

  • UI Components to display validation messages

In addition to the linkki dependency, a linkki application with Vaadin requires several Vaadin dependencies:

    <properties>
        <vaadin.version>8.14.3</vaadin.version>
        <spring-boot.version>2.5.0</spring-boot.version>
        <!-- Ignore duplications due to Vaadin8/14 projects -->
        <sonar.cpd.exclusions>**/*.java</sonar.cpd.exclusions>
    </properties>

        <dependencies>
            <dependency>
                <groupId>com.vaadin</groupId>
                <artifactId>vaadin-server</artifactId>
                <version>${vaadin.version}</version>
            </dependency>
            <dependency>
                <groupId>com.vaadin</groupId>
                <artifactId>vaadin-compatibility-server</artifactId>
                <version>${vaadin.version}</version>
            </dependency>
            <dependency>
                <groupId>com.vaadin</groupId>
                <artifactId>vaadin-themes</artifactId>
                <version>${vaadin.version}</version>
            </dependency>
        </dependencies>

Maven Archetypes

linkki can be used for a plain Vaadin web application, with Spring Boot or with CDI. 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
mvn archetype:generate -DarchetypeGroupId=org.linkki-framework.archetypes -DarchetypeArtifactId=linkki-archetype-plain-application-vaadin8 -DarchetypeVersion=1.4.8

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/main.

linkki with CDI
mvn archetype:generate -DarchetypeGroupId=org.linkki-framework.archetypes -DarchetypeArtifactId=linkki-archetype-cdi-application-vaadin8 -DarchetypeVersion=1.4.8

The resulting application can be deployed to your Java Enterprise Edition 7+ server of choice or simply started with mvn clean package org.apache.tomee.maven:tomee-maven-plugin:run, where it can be viewed at http://localhost:8080/<yourArtifactId>;.

linkki with Spring Boot
mvn archetype:generate -DarchetypeGroupId=org.linkki-framework.archetypes -DarchetypeArtifactId=linkki-archetype-spring-application-vaadin8 -DarchetypeVersion=1.4.8

The resulting application can be started with java -jar target/*.war and be viewed at http://localhost:8080/.

Index

  1. Example project
  2. Dependencies