README.md

Vertx Vaadin

Status

Description

Vertx Vaadin is an adapter library that lets you run Vaadin applications on top of Vert.x. This means you can mix the simplicity and robustness of Vaadin applications with the powerful tools provided by Vert.x, such as event bus, clustering, High Availability and Fail-Over.

Important

Vaadin 8 is not supported anymore.

Installation and Getting Started

Vertx-vaadin binaries are available on Maven Central and Bintray.

Maven

Stable artifacts are published on Maven Central.

<dependency>
  <groupId>com.github.mcollovati.vertx</groupId>
  <artifactId>vertx-vaadin-flow</artifactId>
  <version>${vertx-vaadin-flow.version}</version>
</dependency>

For better compatibility with Flow client, specific vaadin-flow-sockjs artifacts targeting exact Vaadin versions in use are published using the vaadin-${vaadin.version} classifier.

<dependency>
    <groupId>com.github.mcollovati.vertx</groupId>
    <artifactId>vaadin-flow-sockjs</artifactId>
    <version>${vertx-vaadin-flow.version}</version>
    <classifier>vaadin-${vaadin.version}</classifier>
</dependency>

Snapshots and vaadin-flow-sockjs classifiers are currently published on Repsy.

<repositories>
    <repository>
        <id>vertx-vaadin</id>
        <url>https://repo.repsy.io/mvn/mcollovati/vertx-vaadin</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
    <repository>
    <id>vertx-vaadin-snapshots</id>
        <url>https://repo.repsy.io/mvn/mcollovati/vertx-vaadin-snapshots</url>
        <releases>
            <enabled>false</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

Compatibility matrix

Vaadin version	Vert.x version	vertx-vaadin version	Status
24.4	4.5.9+
24.3	4.3.1+
23.3	4.3.1+

Documentation

See vertx-vaadin-flow module for more information.

Demo and samples

Source code for sample application can be found on vaadin-vertx-samples repository.

Issue tracking

The issues for this project are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:

• Fork this project
• Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
• Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
• Refer to the fixed issue in commit
• Send a pull request for the original project
• Comment on the original issue that you have implemented a fix for it

License

Vertx Vaadin is distributed under MIT License. For license terms, see LICENSE.

Acknowledgements

Thanks to:

• David Sowerby (author of Krail framework) for all his precious technical and non technical support.
• Vaadin, and especially Pekka Hyvönen, for allowing me to use Flow UI test code and for the Testbench license.
• Dudeplayz for his valuable feedback.