https://github.com/vaadin/skeleton-starter-flow
Default project template for Vaadin
https://github.com/vaadin/skeleton-starter-flow
getting-started java project-templates vaadin web webcomponents
Last synced: 12 days ago
JSON representation
Default project template for Vaadin
- Host: GitHub
- URL: https://github.com/vaadin/skeleton-starter-flow
- Owner: vaadin
- License: unlicense
- Created: 2017-07-11T06:06:48.000Z (almost 9 years ago)
- Default Branch: v25
- Last Pushed: 2026-04-10T10:04:06.000Z (17 days ago)
- Last Synced: 2026-04-10T10:37:50.280Z (17 days ago)
- Topics: getting-started, java, project-templates, vaadin, web, webcomponents
- Language: Java
- Homepage: https://vaadin.com/start
- Size: 24.5 MB
- Stars: 36
- Watchers: 32
- Forks: 34
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Skeleton Starter for Vaadin
This project can be used as a starting point to create your own Vaadin application.
It has the necessary dependencies and files to help you get started.
The best way to use it is via [vaadin.com/start](https://vaadin.com/start) - you can get only the necessary parts and choose the package naming you want to use.
There is also a [getting started tutorial](https://vaadin.com/tutorials/getting-started-with-flow) based on this project.
To access it directly from github, clone the repository and import the project to the IDE of your choice as a Maven project. You need to have Java 8 or 11 installed.
Run in development mode using `mvn jetty:run` and open [http://localhost:8080](http://localhost:8080) in the browser. If you are deploying to a test server via IDE integration, you probably need to enable `development` profile to get `vaadin-dev` dependency into the development deployment.
If you want to run your app locally in the production mode, run `mvn jetty:run-war` or build a war file with `mvn package` and deploy it manually.
### Running Integration Tests
Integration tests are implemented using [Vaadin TestBench](https://vaadin.com/testbench). The tests take a few minutes to run and are therefore included in a separate Maven profile. To run the tests using Google Chrome, execute
`mvn verify -Pit`
and make sure you have a valid TestBench license installed (you can obtain a
trial license from the [trial page](
https://vaadin.com/trial)).
## Project structure
The project follow Maven's [standard directory layout structure](https://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html):
- Under the `srs/main/java` are located Application sources
- `AppShell.java` configures the @PWA annotation making the application
installable
- `GreetService.java` is a 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/themes`
## Workspace.xml file
IntelliJ IDEA uses `workspace.xml` file to cache user-specific project configuration.
Tracking of local changes to the `workspace.xml` file can be prevented with the `git update-index --assume-unchanged .idea/workspace.xml` command.
And to revert the setting: `git update-index --no-assume-unchanged .idea/workspace.xml`.
## Useful links
- Read the documentation at [vaadin.com/docs](https://vaadin.com/docs).
- Follow the tutorials at [vaadin.com/tutorials](https://vaadin.com/tutorials).
- Watch training videos and get certified at [vaadin.com/learn/training]( https://vaadin.com/learn/training).
- Create new projects at [start.vaadin.com](https://start.vaadin.com/).
- Search UI components and their usage examples at [vaadin.com/components](https://vaadin.com/components).
- Find a collection of solutions to common use cases in [Vaadin Cookbook](https://cookbook.vaadin.com/).
- Find Add-ons at [vaadin.com/directory](https://vaadin.com/directory).
- Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/vaadin) or join our [Discord channel](https://discord.gg/MYFq5RTbBn).
- Report issues, create pull requests in [GitHub](https://github.com/vaadin/).
For a full Vaadin application example, there are more choices available also from [vaadin.com/start](https://vaadin.com/start) page.