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.
Anna Koskinen bcb5aada51 Read-only styles shouldn't override borderless background styles. (#11692) 6 days ago
.github Update stale.yml (#11123) 1 year ago
.settings Update Eclipse project to Java 8 3 years ago
all Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
bom Update Spring addon to 3.2.1 (#11670) 3 weeks ago
checkstyle Update copyright year (#10761) 1 year ago
client Add explicit handling of ctrl-a (#11693) 1 week ago
client-compiled Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
client-compiler Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
compatibility-client Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
compatibility-client-compiled Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
compatibility-server Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
compatibility-server-gae Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
compatibility-shared Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
compatibility-themes Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
documentation Update Chrome version, snapshots and fix tests (#11684) 2 weeks ago
eclipse Configure Eclipse to insert new line at the end of files (#10080) 1 year ago
liferay Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
liferay-integration Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
osgi-integration Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
push Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
scripts Use https for Maven repositories (#11668) 3 weeks ago
server Update Chrome version, snapshots and fix tests (#11684) 2 weeks ago
shared Update the since tag (#11675) 3 weeks ago
test Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
testbench-api Update to 8.10-SNAPSHOT (#11657) 3 weeks ago
themes Read-only styles shouldn't override borderless background styles. (#11692) 6 days ago
uitest Read-only styles shouldn't override borderless background styles. (#11692) 6 days ago
.classpath Update Eclipse project to Java 8 3 years ago
.gitattributes Add *.properties to .gitattributes (#10180) 1 year ago
.gitignore Automatic test for OSGi/karaf 2 years ago
.gitmodules Remove vaadin-screenshots submodule (#10956) 1 year ago
.project Convert Eclipse project to Maven based 3 years ago
CONTRIBUTING.md Update CONTRIBUTING.md to guide people to create fork (#11457) 6 months ago
LICENSE Fix typo in license (#9060) 2 years ago
README-TESTS.md Updated instructions on how to run TB3+ tests with Intellij; added Qu… (#11580) 3 months ago
README.md Updated instructions on how to run TB3+ tests with Intellij; added Qu… (#11580) 3 months ago
pom.xml Update to 8.10-SNAPSHOT (#11657) 3 weeks ago

README.md

Gitter

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, core.fileMode=false and core.longpaths=true.
  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 framework 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>

For full instructions please visit README-TESTS.md.

Setting up IntelliJ IDEA to Develop Vaadin Framework 8

  1. Install 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>

For full instructions please visit README-TESTS.md.

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>