Osiris-Team / base-starter-spring-gradle

Starting point for a Spring Boot based Vaadin application using Gradle build

Vaadin Gradle Skeleton Starter Spring Boot

This project demos the possibility of having Vaadin project in npm+webpack mode using Gradle. Please see the Starting a Vaadin project using Gradle for the documentation.

Prerequisites:

• Java 17 or higher
• Git
• (Optionally): Intellij Community
• (Optionally): Node.js and npm, if you have JavaScript/TypeScript customisations in your project.
  • You can either let the Vaadin Gradle plugin to install Node.js and npm/pnpm for you automatically, or you can install it to your OS:
  • Windows: node.js Download site - use the .msi 64-bit installer
  • Linux: sudo apt install npm

Vaadin Versions

• The v24 branch (the default one) contains the example app for Vaadin latest version
• See other branches for other Vaadin versions.

Running With Spring Boot via Gradle In Development Mode

Run the following command in this repo:

./gradlew clean bootRun

Now you can open the http://localhost:8080 with your browser.

Running With Spring Boot from your IDE In Development Mode

Run the following command in this repo, to create necessary Vaadin config files:

./gradlew clean vaadinPrepareFrontend

The build/vaadin-generated/ folder will now contain proper configuration files.

Open the DemoApplication class, and Run/Debug its main method from your IDE.

Now you can open the http://localhost:8080 with your browser.

Building In Production Mode

Run the following command in this repo:

./gradlew clean build -Pvaadin.productionMode

That will build this app in production mode as a runnable jar archive; please find the jar file in build/libs/base-starter-spring-gradle*.jar. You can run the JAR file with:

cd build/libs/
java -jar base-starter-spring-gradle*.jar

Now you can open the http://localhost:8080 with your browser.

Building In Production On CI

Usually the CI images will not have node.js+npm available. Vaadin uses pre-compiled bundle when possible, i.e. Node.js is not always needed. Or Vaadin Gradle Plugin will download Node.js for you automatically if it finds any front-end customisations, there is no need for you to do anything. To build your app for production in CI, just run:

./gradlew clean build -Pvaadin.productionMode