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 822fdb4625 Release notes (#11842) 6 天之前
.github Update stale.yml (#11123) 1 年之前
.settings Update Eclipse project to Java 8 3 年之前
all Release notes (#11842) 6 天之前
bom Update context menu addon version (#11735) 2 月之前
checkstyle Update copyright year (#10761) 1 年之前
client Close window on ESC, when maximized button is clicked (#11840) 1 周之前
client-compiled Update to 8.10-SNAPSHOT (#11657) 4 月之前
client-compiler Update to 8.10-SNAPSHOT (#11657) 4 月之前
compatibility-client Fix issue where Chrome refused to select text in Table (#11709) (#11818) 3 週之前
compatibility-client-compiled Update to 8.10-SNAPSHOT (#11657) 4 月之前
compatibility-server Update to 8.10-SNAPSHOT (#11657) 4 月之前
compatibility-server-gae Update to 8.10-SNAPSHOT (#11657) 4 月之前
compatibility-shared Update to 8.10-SNAPSHOT (#11657) 4 月之前
compatibility-themes Update to 8.10-SNAPSHOT (#11657) 4 月之前
documentation Removed a duplicated word in a note. (#11785) 1 月之前
eclipse Configure Eclipse to insert new line at the end of files (#10080) 2 年之前
liferay Update to 8.10-SNAPSHOT (#11657) 4 月之前
liferay-integration Update to 8.10-SNAPSHOT (#11657) 4 月之前
osgi-integration Update to 8.10-SNAPSHOT (#11657) 4 月之前
push Update to 8.10-SNAPSHOT (#11657) 4 月之前
scripts Use https for Maven repositories (#11668) 4 月之前
server Added @since tags, some tweaks to formatting. (#11839) 1 周之前
shared Make sure Firefox for iOS isn't detected as too old to function. (#11739) 2 月之前
test Add support for excess slashes within static file request path. (#11827) 3 週之前
testbench-api Update to 8.10-SNAPSHOT (#11657) 4 月之前
themes Read-only styles shouldn't override borderless background styles. (#11692) 4 月之前
uitest Test tweaks (#11841) 1 周之前
.classpath Update Eclipse project to Java 8 3 年之前
.gitattributes Add *.properties to .gitattributes (#10180) 2 年之前
.gitignore Automatic test for OSGi/karaf 2 年之前
.gitmodules Remove vaadin-screenshots submodule (#10956) 1 年之前
.project Convert Eclipse project to Maven based 3 年之前
CONTRIBUTING.md Update CONTRIBUTING.md to guide people to create fork (#11457) 10 月之前
LICENSE Fix typo in license (#9060) 2 年之前
README-TESTS.md Updated local screenshot testing configurations. (#11814) 3 週之前
README.md Updated instructions on how to run TB3+ tests with Intellij; added Qu… (#11580) 7 月之前
pom.xml Update to 8.10-SNAPSHOT (#11657) 4 月之前

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>