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.
Teemu Suo-Anttila 0a3d0a12aa Use new validation screenshots 6 years ago
.github Introduce issue template (#8043) 7 years ago
.settings Update Eclipse project to Java 8 7 years ago
all Revert Grid row height per section feature (#9823) 6 years ago
bom Snapshot version update to 8.1 (#9023) 7 years ago
buildhelpers Add OSGi support #8830 #8827 #8828 #8829 7 years ago
checkstyle Ignore missing package.html in checkstyle 7 years ago
client Fix Grid initial render performance (#10579) 6 years ago
client-compiled Rename OSGi classes for Java naming conventions (#9320) 6 years ago
client-compiler Add LoadStyle.NONE for completely omitting a connector 7 years ago
compatibility-client Fix missing since tag in compatibility package Grid 6 years ago
compatibility-client-compiled Rename OSGi classes for Java naming conventions (#9320) 6 years ago
compatibility-server Fix occasional empty rows in Table and TreeTable (#9800) 6 years ago
compatibility-server-gae Fix parent version in some POMs 7 years ago
compatibility-shared Add missing fields to OSGi manifests 7 years ago
compatibility-themes Add source JAR to themes and compatibility-themes (#9709) 6 years ago
documentation Correct DOCTYPE of GWT widgetset 6 years ago
eclipse Add a maven plugin for formatting according to Eclipse settings 7 years ago
liferay Snapshot version update to 8.1 (#9023) 7 years ago
liferay-integration Enable Declarative Services in OSGi portlet UI (#9879) 6 years ago
osgi-integration Tidy up the Vaadin OSGi whiteboard component (#9648) 6 years ago
push Rename OSGi classes for Java naming conventions (#9320) 6 years ago
scripts Add docker feature to demo build script (#9828) 6 years ago
server Fix Grid initial render performance (#10579) 6 years ago
shared Fix setting custom tab index for TabSheet or Accordion (#9574) (#10278) 6 years ago
test Add wait for UI load to test 6 years ago
testbench-api Fix RadioButtonGroup selection updates to client (#9749) 6 years ago
tests Use new validation screenshots 6 years ago
themes adds simple fix for missing label text in grid select checkboxes (#10223) 6 years ago
uitest Fix Grid initial render performance (#10579) 6 years ago
.classpath Update Eclipse project to Java 8 7 years ago
.gitignore Automatic test for OSGi/karaf 6 years ago
.gitmodules Add screenshot submodule to master branch (#88) 7 years ago
.project Convert Eclipse project to Maven based 8 years ago
CONTRIBUTING.md Fixed minor typos and spelling issues in CONTRIBUTING.md guide (#9683) 6 years ago
LICENSE Fix typo in license (#9060) 7 years ago
README-TESTS.md Converted old Framework TestBench test docs to markdown (#8084) 7 years ago
README.md Update README.md (#9612) 6 years ago
pom.xml Use GWT 2.8.2 (#10217) 6 years ago

README.md

Vaadin Framework

Vaadin Framework allows you to build modern web apps efficiently in plain Java, without touching 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 environment 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/framework.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:8888/run/<testUI>

Setting up IntelliJ IDEA to Develop Vaadin Framework 8

  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/framework.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>