/vaadin-todo

Primary LanguageJavaThe UnlicenseUnlicense

Project Base for Vaadin and Spring Boot

This project can be used as a starting point to create your own Vaadin application with Spring Boot. It contains all the necessary configuration and some placeholder files to get you started.

The best way to create your own project based on this starter is via start. vaadin.com.

Running the Application

The project is a standard Maven project. To run it from the command line, type mvn and open http://localhost:8080 in your browser.

You can also import the project to your IDE of choice as you would with any Maven project. Read more on how to set up a development environment for Vaadin projects (Windows, Linux, macOS).

Running Integration Tests

Integration tests are implemented using Vaadin TestBench. The tests take a few minutes to run and are therefore included in a separate Maven profile. We recommend running tests with a production build to minimize the chance of development time toolchains affecting test stability. To run the tests using Google Chrome, execute

mvn verify -Pit,production

and make sure you have a valid TestBench license installed (you can obtain a trial license from the trial page).

Project structure

The project follow Maven's standard directory layout structure:

  • Under the srs/main/java are located Application sources
    • Application.java is a runnable Java application class and the app's starting point
    • GreetService.java is a Spring service class
    • MainView.java is an example Vaadin view
  • Under the srs/test are located the TestBench test files
  • src/main/resources contains configuration files and static resources
  • The frontend directory in the root folder contains client-side dependencies and resource files. Example CSS styles used by the application are located under frontend/styles

Useful links