IntelliJ IDEA 2017.1 Help

Getting Started with Vaadin-Maven Project

This feature is supported in the Ultimate edition only.

IntelliJ IDEA lets you create and manage a Maven project with Vaadin archetype.

Creating Maven project with Vaadin archetype

  1. Open Project Wizard, under Maven, select Create from archetype check box and click Add archetype.
  2. In the dialog that opens, enter maven GroupId, ArtifactId and Version.
    /help/img/idea/2017.1/create_maven_vaadin_arch.png
  3. After you click OK, the Vaadin archetype is added to the list of available archetypes. Click Next.
    /help/img/idea/2017.1/vaadin_archetype_added.png
  4. On the next page of the wizard, enter maven information for your project and click Next.
    /help/img/idea/2017.1/vaadin_maven_gr_id.png
  5. On the next page of the wizard, enter maven settings for your project and click Next.
    /help/img/idea/2017.1/vaadin_maven_info.png
  6. On the next page of the wizard, enter your project's information and click Finish.
    /help/img/idea/2017.1/vaadin_maven_project_info.png

IntelliJ IDEA creates a maven project with pom.xml. IntelliJ IDEA also recognizes that this is a Web application and creates a webapp in your source directory.

Import an external Vaadin project with Maven

You can import external Vaadin project using VCS and check out your project from, for example, Git. In this case IntelliJ IDEA automatically converts your project structure, detects necessary frameworks and downloads appropriate dependencies.

  1. In the Project Wizard, click Check out from Version Control and from the drop-down list, select Git.
    /help/img/idea/2017.1/vaadin_maven_git.png
  2. Specify Git Repository from which you want to clone your project, a Parent Directory location and the name of the parent directory. Click Clone.
    /help/img/idea/2017.1/vaadin_maven_clone_rep.png

    IntelliJ IDEA copies git project to your local directory, recognizes POM file, meaning it recognizes that this is a Maven project with Vaadin framework and imports the project with all the necessary configurations.

    /help/img/idea/2017.1/vaadin_maven_cvs.png
  3. Check project structure to make sure that all necessary dependencies are downloaded.
    /help/img/idea/2017.1/vaadin_maven_proj_str.png
    The frameworks are configured automatically, so you can exclude the detected ones.
    /help/img/idea/2017.1/vaadin_maven_facet_detection.png

Configure run/debug settings and run application

IntelliJ IDEA lets you quickly configure Run/Debug settings for your project.

  1. On the main menu, select Run | Edit Configurations.
  2. Click /help/img/idea/2017.1/new.png to add a new configuration from the list, specify the appropriate parameters for your configuration and press OK.
    /help/img/idea/2017.1/vaadin_maven_run_debug_conf.png
  3. On the main menu press /help/img/idea/2017.1/run.png to run the application.

You can view the output in the default browser http://localhost:8080/.

Last modified: 18 July 2017