This tutorial teaches you some of the basic concepts in Vaadin Framework. It is meant to be a fast read for learning how to get started - not an example on how application should be designed. Please note this example uses and requires Java 8 to work.
$ mvn jetty:run
These instructions were tested on IntelliJ IDEA 14 CE. You can get it from https://www.jetbrains.com/idea/
To get the project up and running in IDEA, do:
- File -> New -> Project from Version Control -> Git
- The URL to use is https://github.com/vaadin/addressbook.git
- If you get a message about "Non-managed pom.xml file found". Choose "Add as Maven Project"
- If you get a message about no JDK or SDK being selected. Choose "Configure" and select your installed JDK. You can also set the JDK using File -> Project Structure
- To start the project, find the "Maven Projects" tab on the right hand side of the screen and navigate to
- Vaadin Web Application -> Plugins -> jetty -> jetty:run
- Click the play button or right click and select Run (Select Debug instead to run in debug mode)
You should now have a Jetty server running on localhost:8080. Navigate to http://localhost:8080 to play with the application
These instructions were tested on NetBeans 8.0.2. You can get it from https://www.netbeans.org
To checkout and run the project in NetBeans, do:
- Team -> Git -> Clone
- Set repository URL to https://github.com/vaadin/addressbook.git
- Finish
- Right click the imported project (Vaadin Addressbook Application) and select Run
- Select GlassFish Server 4.1 -> Remember in Current IDE Session -> OK
You should now have a GlassFish server running on localhost:8080 and a browser tab should also be automatically opened with this location
These instructions were tested on Eclipse IDE for Java EE Developers Luna SR2. You can get it from http://eclipse.org/downloads/
To checkout and run the project in Eclipse, do:
- File -> Import...
- Check out Maven Projects from SCM
- Choose Git from SCM menu
- If you do not see "Git" in the SCM menu, click "Find more SCM connectors in the m2e Marketplace" and install "m2e-egit". Restart Eclipse and start over.
- Set the repository URL to https://github.com/vaadin/addressbook.git
- Right click the imported "addressbook" and choose Run As -> Maven Build...
- Set the goal to "jetty:run" and click "Run"
You should now have a Jetty server running on localhost:8080. Navigate to http://localhost:8080/ to play with the application
To use the built in server adapters of Eclipse, instead of doing "Run As -> Maven Build..." you can do
- Run As -> Run on Server
- Select the server you want to run on, e.g. Apache Tomcat 8 and click ok
- Do not use the suggested J2EE Preview server as it is outdated, deprecated and does not support Servlet 3, which is required for this application
- Maven
- ANT
- Java (preferrably JDK 7+)
- PMD (Optional - if not installing it, remove references to PMD in Ant build files)
- Cobertura (Optional, bu recommended)
- Download PMD from https://github.com/pmd/pmd/releases/download/pmd_releases%2F5.4.0/pmd-bin-5.4.0.zip
- Unzip file to c:\apps\pmd
- Set System Variable PMD_HOME to c:\apps\pmd
- Download MAven and unzip to a folder
- set MAVEN_HOME to name of folders where it was unzipped.
- Download MAven and unzip to a folder
- set ANT_HOME to name of folders where it was unzipped.
- download and copy following files to %ANT_HOME%\lib folder
- sonarqube-ant-task-2.4.jar
- ant-contrib.jar (Download from from http://sourceforge.net/projects/ant-contrib/files/ant-contrib/ant-contrib-1.0b2/ (Do not use 1.0b3))
- maven-ant-tasks-2.1.3.jar
- Adjust paths in build.xml/build.properties as per your local configuration
*** End of documentation