You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Olli Tietäväinen c75580aa4e
Merge branch '7.7' into fix11502-4
5 years ago
.settings Convert Eclipse project to Maven based 8 years ago
all Add note about JRE9+ not being supported 5 years ago
bom Change snapshot version 7.7-SNAPSHOT 7 years ago
buildhelpers Update Copyright headers for year 2018 (#10762) 6 years ago
checkstyle Update Copyright headers for year 2018 (#10762) 6 years ago
client Merge branch '7.7' into fix11502-4 5 years ago
client-compiled Format project pom files using correct settings (4 spaces) 7 years ago
client-compiler Update Copyright headers for year 2018 (#10762) 6 years ago
documentation Fix typo (#11466) 5 years ago
eclipse Remove obsolete launch files 8 years ago
liferay Format project pom files using correct settings (4 spaces) 7 years ago
push Format project pom files using correct settings (4 spaces) 7 years ago
scripts testbench-api is generated later in the release process nowadays; if it's listed here, it will give a red light for the staging report (#11336) 5 years ago
server added missing since 7.7.16 (#11418) 5 years ago
shared V7: Improve VMenuBar click handling logic (#11362) 5 years ago
test Introduce servlet container tests from Vaadin 8 (#11128) 5 years ago
tests Fix validation build to work with new build agents (#11054) 5 years ago
themes Allow configuring content modes for Grid cell tooltips (#10396) 6 years ago
uitest copied waitUntil to selectMenuPath from FW8 (#11415) 5 years ago
widgets Update Copyright headers for year 2018 (#10762) 6 years ago
.classpath Convert Eclipse project to Maven based 8 years ago
.gitignore Introduce servlet container tests from Vaadin 8 (#11128) 5 years ago
.gitmodules Add screenshots as a Git submodule (#86) 7 years ago
.project Convert Eclipse project to Maven based 8 years ago
LICENSE Specify the license of the documentation in the LICENSE file. 8 years ago
README.md Run devserver under IDEA via maven target (#11152) 5 years ago
build.properties Upgrade GWT version 6 years ago
common.xml Run checkstyle with Maven 8 years ago
ivy-taskdefs.xml Use Maven to build vaadin-push 8 years ago
ivysettings.xml Use parameter for uitest Ivy repository 8 years ago
pom-template.xml Use vaadin-parent as parent in POMs (#17300) 9 years ago
pom.xml update to Jetty 9.4 (#11411) 5 years ago

README.md

Vaadin Framework

Vaadin Framework allows you to build modern web apps efficiently in plain Java, without touchking low level web technologies.

For instructions about using Vaadin to develop applications, please refer to Vaadin tutorial and other documentation.

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.

Building a package

The distribution files can be built by running the standard Maven goal mvn install in the project root.

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/

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 specific UI test

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

Running a Development Server

  1. Open Run menu and click Edit Configurations
  2. Click green + sign at top left corner, select Maven from popup
  3. In the run configuration page, set any name for the configuration, select vaadin-uitest project folder as Working directory
  4. Type exec:exec@run-development-server into Command line and save the configuration
  5. Run the configuration and open URL http://localhost:8888/run/<testUI>

Running a Development Server in a debug mode

  1. Type exec:exec@debug-development-server into Command line and save the configuration
  2. In the same dialog, create new “Remote” debug configuration, using localhost and Port 5005
  3. Start both configurations and open URL http://localhost:8888/run/<testUI>