Beverage Buddy App Starter for Vaadin Flow
:coffee::tea::sake::baby_bottle::beer::cocktail::tropical_drink::wine_glass:
This is a Vaadin platform example application created with Java and HTML. It is used to demonstrate features of Vaadin platform.
The easiest way of using it is via https://vaadin.com/start - you can choose the vaadin version and the package naming you want. If you want to use it with the latest vaadin version you can use this direct link.
The Starter demonstrates the core Vaadin Flow concepts:
- Building UIs in Java with Components based on Vaadin components, such as
TextField,Button,ComboBox,DatePicker,VerticalLayoutandGrid(seeCategoriesList) - Creating forms with
Binder(seeReviewEditorDialog) - Making reusable Components on the server side (see
AbstractEditorDialog) - Creating a Component based on a HTML Template (see
ReviewsList)- This template can be opened and edited with the Vaadin Designer
- Creating Navigation with the Router API (See
MainLayout,ReviewsListandCategoriesList)
Prerequisites
The project can be imported into the IDE of your choice, with Java 8 or 11 installed, as a Maven project.
But additionally you need node.js installed in your System, and available in your PATH.
See the Node.js page for the installation instructions.
Dependencies
Dependencies are managed by Vaadin platform and vaadin-maven-plugin.
Running the Project in Developer Mode
- Run
mvn jetty:run - Wait for the application to start
- Open http://localhost:8080/ to view the application
Note that there are some files/folders generated in the project structure automatically. You can find some information about them here.
Production Mode
- Run
mvn package -Pproductionto get the artifact. - Deploy the
target/beveragebuddy-2.0-SNAPSHOT.war.
If you want to run the production build using the Jetty plugin, use mvn jetty:run -Pproduction and navigate to the http://localhost:8080/.
Documentation
Brief introduction to the application parts can be found from the documentation folder. For Vaadin documentation for Java users, see Vaadin.com/docs.
Adding new templates
To add a new template or a style to the project create the JavaScript module in the ./frontend directory.
Then in the PolymerTemplate using the P3 element add the JsModule annotation e.g. @JsModule("./src/views/reviewslist/reviews-list.js")
Branching information
masterthe latest version of the starter, using the latest platform versionv10the version for Vaadin Platform 10v11the version for Vaadin Platform 11v12the version for Vaadin Platform 12v13the version for Vaadin Platform 13