README.md

   1 vaadin01
   2 ==============
   3
   4 Template for a simple Vaadin application that only requires a Servlet 3.0 container to run.
   5
   6
   7 Workflow
   8 ========
   9
  10 To compile the entire project, run "mvn install".
  11 To run the application, run "mvn jetty:run" and open http://localhost:8080/ .
  12
  13 To develop the theme, simply update the relevant theme files and reload the application.
  14 Pre-compiling a theme eliminates automatic theme updates at runtime - see below for more information.
  15
  16 Debugging client side code
  17   - run "mvn vaadin:run-codeserver" on a separate console while the application is running
  18   - activate Super Dev Mode in the debug window of the application
  19
  20 To produce a deployable production mode WAR:
  21 - change productionMode to true in the servlet class configuration (nested in the UI class)
  22 - run "mvn clean vaadin:compile-theme package"
  23   - See below for more information. Running "mvn clean" removes the pre-compiled theme.
  24 - test with "mvn jetty:run-war
  25
  26 Using a precompiled theme
  27 -------------------------
  28
  29 When developing the application, Vaadin can compile the theme on the fly when needed,
  30 or the theme can be precompiled to speed up page loads.
  31
  32 To precompile the theme run "mvn vaadin:compile-theme". Note, though, that once
  33 the theme has been precompiled, any theme changes will not be visible until the
  34 next theme compilation or running the "mvn clean" target.
  35
  36 When developing the theme, running the application in the "run" mode (rather than
  37 in "debug") in the IDE can speed up consecutive on-the-fly theme compilations
  38 significantly.
  39
  40 Using Vaadin pre-releases
  41 -------------------------
  42
  43 If Vaadin pre-releases are not enabled by default, use the Maven parameter
  44 "-P vaadin-prerelease" or change the activation default value of the profile in pom.xml .