|
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- # Vaadin Framework
-
- *[Vaadin Framework](https://vaadin.com/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](https://vaadin.com/docs/-/part/framework/tutorial.html) and other [documentation](https://vaadin.com/docs/).
-
- To contribute, first refer to [Contributing Code](https://github.com/vaadin/framework/blob/master/CONTRIBUTING.md)
- 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
- <code>git clone https://github.com/vaadin/framework.git</code>
- 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`.
- 1. Run <code>mvn install</code> in the project root.
- Note that the first compilation takes a while to finish as maven downloads dependencies used in the projects.
- 1. 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.
- 1. Import the project into Eclipse as a maven project. Use *File* -> *Import* -> *Maven* -> *Existing Maven Projects*.
- 1. Select the *vaadin* folder (where you cloned the project)
- 1. 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 <code>install</code> 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 <code>install</code> 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)
- 1. Go to *General* -> *Workspace*
- 1. Set *Text file encoding* to *UTF-8*
- 1. Set *New text file line delimiter* to *Unix*
- 1. 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*
- 1. Open *Run As* -> *Maven build...*
- 1. Type in <code>jetty:run-exploded</code> into *Goals* and click *Run*
- 1. Open URL [http://localhost:8888/run/<testUI>](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.
- 1. Ensure if Git and Maven plugins are installed, properly configured and enabled.
- 1. 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.
- 1. Open cloned repository as a maven object. Use File -> Open and choose root _pom.xml_ file
- 1. Have a coffee break while IDEA is loading dependencies and indexing the project
- 1. Run Maven targets <code>clean</code> and <code>install</code> using *Maven Projects* tool window to compile the whole project
-
- ### Running a specific UI test
-
- 1. Open *Maven Projects*
- 1. Open *vaadin-uitest* -> *Plugins* -> *jetty* -> *jetty:run-exploded*
- 1. Open URL [http://localhost:8888/run/<testUI>](http://localhost:8888/run/<testUI>)
-
- ### Running a Development Server
-
- 1. Open *Run* menu and click *Edit Configurations*
- 1. Click green ***+*** sign at top left corner, select *Maven* from popup
- 1. In the run configuration page, set any name for the configuration, select *vaadin-uitest* project folder as *Working directory*
- 1. Type <code>exec:exec@run-development-server</code> into *Command line* and save the configuration
- 1. Run the configuration and open URL [http://localhost:8888/run/<testUI>](http://localhost:8888/run/<testUI>)
-
- ### Running a Development Server in a debug mode
-
- 1. Type <code>exec:exec@debug-development-server</code> into *Command line* and save the configuration
- 1. In the same dialog, create new "Remote" debug configuration, using *localhost* and *Port 5005*
- 1. Start both configurations and open URL [http://localhost:8888/run/<testUI>](http://localhost:8888/run/<testUI>)
|