Vaadin

Vaadin is a Java framework for building modern web applications that look great, perform well and make you and your users happy.

For instructions about using Vaadin to develop applications, please refer to https://vaadin.com/learn

To contribute, first refer to Contributing Code for general instructions and requirements for contributing code to the Vaadin framework.

Instructions on how to set up a working environments for developing the Vaadin framework follow below.

Eclipse Quick Setup

1. Run git clone https://github.com/vaadin/vaadin.git command or clone the repository your favorite Git tool. If using Windows, you might want to add these Git settings: core.autocrlf=false and core.fileMode=false.
2. Run mvn install in the project root. Note that the first compilation takes a while to finish as maven downloads dependencies used in the projects.
3. Start Eclipse with the workspace you would like to use. It is usually a good idea to use the parent folder of the Git repository as the workspace folder.
4. Import the project into Eclipse as a maven project. Use File -> Import -> Maven -> Existing Maven Projects.
5. Select the vaadin folder (where you cloned the project)
6. Click “Finish” to complete the import of Vaadin Framework

Now the project should compile without further configuration.

Compiling the Default Widget Set and Themes

• Compile the default widgetset by running install maven goal in vaadin-client-compiled module root. In Eclipse this is done by right clicking on vaadin-client-compiled project it and choosing Run As -> Maven Build….
• Compile the default themes by running install maven goal in vaadin-themes module root. In Eclipse this is done by right clicking on vaadin-themes project it and choosing Run As -> Maven Build….

Set up extra workspace preferences

The following preferences need to be set to keep the project consistent. You need to do this especially to be able to contribute changes to the project.

1. Open Window -> Preferences (Windows) or Eclipse -> Preferences (Mac)
2. Go to General -> Workspace
   1. Set Text file encoding to UTF-8
   2. Set New text file line delimiter to Unix
3. Go to XML -> XML Files -> Editor
   1. Ensure the settings are follows:

      Line width: 72
      Format comments: true
      Join lines: true
      Insert whitespace before closing empty end-tags: true
      Indent-using spaces: true
      Indentation size: 4
      

Running a UI test

1. In a Project Explorer right-click vaadin-uitest
2. Open Run As -> Maven build…
3. Type in jetty:run-exploded into Goals and click Run
4. Open URL http://localhost:8080/run/

Building a package

The distribution files can be built by running maven goal

maven clean install

in the project root directory.

To use a specific version number, modify <version> tag in root pom.xml file. This goal runs all project tests TestBench tests, which require access to a a TestBench cluster, currently only available internally at Vaadin Ltd.

Setting up IntelliJ IDEA to Develop Vaadin 7

1. Intall and run IDEA. Ultimate Edition is better but Community Edition should also work.
2. Ensure if Git and Maven plugins are installed, properly configured and enabled.
3. Clone the repository, using menu VCS -> Checkout from Version Control -> Git -> Git Repository URL -> https://github.com/vaadin/vaadin.git. When the repository is cloned, do NOT open it as a project.
4. Open cloned repository as a maven object. Use File -> Open and choose root pom.xml file
5. Have a coffee break while IDEA is loading dependencies and indexing the project
6. Run Maven targets clean and install using Maven Projects tool window to compile the whole project

Running a UI test

1. Open Maven Projects
2. Open vaadin-uitest -> Plugins -> jetty -> jetty:run-exploded
3. Open URL http://localhost:8080/run/