https://github.com/mcollovati/vertx-vaadin
Run Vaadin UI on Vert.x
https://github.com/mcollovati/vertx-vaadin
vaadin vertx vertx-web
Last synced: 21 days ago
JSON representation
Run Vaadin UI on Vert.x
- Host: GitHub
- URL: https://github.com/mcollovati/vertx-vaadin
- Owner: mcollovati
- License: mit
- Created: 2018-03-04T19:47:00.000Z (about 7 years ago)
- Default Branch: development
- Last Pushed: 2025-03-24T17:02:46.000Z (about 1 month ago)
- Last Synced: 2025-04-09T16:18:07.512Z (21 days ago)
- Topics: vaadin, vertx, vertx-web
- Language: Java
- Size: 3.33 MB
- Stars: 44
- Watchers: 9
- Forks: 17
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - mcollovati/vertx-vaadin - Run Vaadin UI on Vert.x (Java)
- vertx-awesome - Vert.x Vaadin - Run Vaadin applications on Vert.x. (Web Frameworks)
README
# Vertx Vaadin
## Status
)
## Description
Vertx Vaadin is an adapter library that lets you run [Vaadin](https://vaadin.com/) applications on top of [Vert.x](http://vertx.io/).
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.
```xml
com.github.mcollovati.vertx
vertx-vaadin-flow
${vertx-vaadin-flow.version}
```
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.
```xml
com.github.mcollovati.vertx
vaadin-flow-sockjs
${vertx-vaadin-flow.version}
vaadin-${vaadin.version}
```
Snapshots and `vaadin-flow-sockjs` classifiers are currently published on [Repsy](https://repsy.io/).
```xml
vertx-vaadin
https://repo.repsy.io/mvn/mcollovati/vertx-vaadin
true
false
vertx-vaadin-snapshots
https://repo.repsy.io/mvn/mcollovati/vertx-vaadin-snapshots
false
true
```
## Compatibility matrix
| Vaadin version | Vert.x version | vertx-vaadin version | Status |
|----------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| 24.6 | 4.5.9+ |  |  |
| 24.5 | 4.5.9+ |  |  |
| 24.4 | 4.5.9+ |  |  |
| 24.3 | 4.3.1+ |  |  |
| 23.3 | 4.3.1+ |  |  |
## Documentation
See [vertx-vaadin-flow](vertx-vaadin-flow-parent/vertx-vaadin-flow) module for more information.
## Demo and samples
Source code for sample application can be found on [vaadin-vertx-samples](https://github.com/mcollovati/vaadin-vertx-samples) repository.
## Issue tracking
The issues for this project are tracked on its [github.com page](https://github.com/mcollovati/vertx-vaadin/issues). 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](LICENSE).
## Acknowledgements
Thanks to:
* [David Sowerby](https://github.com/davidsowerby) (author of [Krail framework](https://github.com/davidsowerby/krail)) for all his precious technical and non technical support.
* [Vaadin](https://vaadin.com/), and especially [Pekka Hyvönen](https://twitter.com/plekuu), for allowing me to use
Flow UI test code and for the [Testbench](https://vaadin.com/testbench) license.
* [Dudeplayz](https://github.com/Dudeplayz) for his valuable feedback.