Starting a Project
- Starter Projects
- Maven Archetype
You can use a Maven archetype to generate a Vaadin web application with a preconfigured Jetty Maven plugin in it. Once it’s created, you can import it into your IDE.
Most IDEs support creating a project from a Maven archetype. See your IDE and its documentation for instructions.
On the command line, you can generate a project as follows:
mvn -B archetype:generate \ -DarchetypeGroupId=com.vaadin \ -DarchetypeArtifactId=vaadin-archetype-application \ -DarchetypeVersion=LATEST \ -DgroupId=org.example \ -DartifactId=my-webapp \ -Dversion=1.0-SNAPSHOT
The parameters are as follows:
The group ID of the archetype is
com.vaadinfor Vaadin archetypes.
The archetype ID. There is currently one archetype,
Version of the archetype to use.
LATESTselects the latest version. For pre-release versions, it should be the exact version number, such as
A Maven group ID for your project. This is normally your organization domain name in reverse order, such as
com.example. The group ID is also used as a prefix for the Java package in the sources. For this reason, it should be Java-compatible; that is, consisting of only alphanumeric characters and the underscore character.
Identifier of the artifact, that is, your project. The identifier may contain alphanumeric and underscore characters. It’s appended to the group ID to create the Java package name for the sources. For example, if the group ID is
com.exampleand the artifact ID is
myproject, the project sources are placed in the
The initial version number of your application. The number must follow the Maven version numbering format.
Creating a project can take a while, as Maven fetches all the dependencies.