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.
elmot 837ddd4eb0 Vaadin-icons 3.0.1 with copyright added. 7 years ago
.github Introduce issue template (#8043) 7 years ago
.settings Update Eclipse project to Java 8 7 years ago
all Add Payara as an officially supported server (#8520) 7 years ago
bom Use TestBench version 5.0.0.beta5 (#8557) 7 years ago
buildhelpers Add a maven plugin for formatting according to Eclipse settings 7 years ago
checkstyle Ignore missing package.html in checkstyle 7 years ago
client HTML5 Drag and Drop Support (#8264) 7 years ago
client-compiled Add Eclipse launch configurations for super dev mode 7 years ago
client-compiler Global java code cleanup using Eclipse Neon.1 7 years ago
compatibility-client Fix toggling of WeekNumbers for DateTimeField. (#8468) 7 years ago
compatibility-client-compiled Make it easy to run Sonar on the project (#8118) 7 years ago
compatibility-server Increase threshold in server side performance test for stability (#8370) 7 years ago
compatibility-shared Make it easy to run Sonar on the project (#8118) 7 years ago
compatibility-themes Overload AbstarctComponent.setDescription() with content mode parameter (#8252) 7 years ago
documentation Fixed typo in application-environment.asciidoc (#8546) 7 years ago
eclipse Add a maven plugin for formatting according to Eclipse settings 7 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 Fix build report checking for vaadin-bom (#8537) 7 years ago
server Clarify set/addSortComparator parameter name (#8562) 7 years ago
shared HTML5 Drag and Drop Support (#8264) 7 years ago
test Update test for Spring 1.5.1.RELEASE (#8535) 7 years ago
testbench-api Use TestBench version 5.0.0.beta5 (#8557) 7 years ago
tests Fix Firefox 45 tests (click issues, screenshots) (#8533) 7 years ago
themes HTML5 Drag and Drop Support (#8264) 7 years ago
uitest Fix GridDetailsLayoutExpandTest (#8556) 7 years ago
uitest-common Add workarounds for Firefox in context click tests (#8547) 7 years ago
.classpath Update Eclipse project to Java 8 7 years ago
.gitignore Fix vaadin-test and all its submodules (#8076) 7 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 Update CONTRIBUTING.md (#8225) 7 years ago
LICENSE Specify the license of the documentation in the LICENSE file. 8 years ago
README-TESTS.md Converted old Framework TestBench test docs to markdown (#8084) 7 years ago
README.md Replace github.com/vaadin/vaadin with github.com/vaadin/framework (#75) 7 years ago
pom.xml Vaadin-icons 3.0.1 with copyright added. 7 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: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/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:8080/run/

Running a Development Server

  1. Open File -> New -> Module…
    1. Choose type Java and click Next
    2. Type in name uitest-run and set Content Root and Module File Location to <your project location>/uitest-run
    3. Click Finish
  2. Open File -> Project Structure…
    1. Choose uitest-run module
    2. Open Dependencies tab
    3. Click + -> Module Dependency -> vaadin-uitest -> OK
    4. Click + -> Library… -> New Library… -> From Maven
    5. Type in org.eclipse.jetty.aggregate:jetty-all:9.4.0.M0 and press Tab
    6. Wait a little while Idea is trying to download the library, then click OK
    7. Close Project Structure dialog by pressing OK
  3. Open Run -> Edit Configurations… then create a new configuration of type Application named DevelopmentServerLauncher
    1. Set Main class to com.vaadin.launcher.DevelopmentServerLauncher
    2. Set Single instance only checkmark
    3. Set VM options to -ea
    4. Set Use classpath options to uitest-run
    5. Set Working directory to uitest
    6. Close Run/Debug Configurations dialog by pressing OK

The run configuration is ready.