Vaadin8/workspace_01/single_module_application/README.md

   1 single_module_application with jetty:run\r
   2 ==============\r
   3 \r
   4 Template for a simple Vaadin application that only requires a Servlet 3.0 container to run.\r
   5 \r
   6 \r
   7 Workflow\r
   8 ========\r
   9 \r
  10 To compile the entire project, run "mvn install".\r
  11 \r
  12 To run the application, run "mvn jetty:run" and open http://localhost:8080/ .\r
  13 \r
  14 To produce a deployable production mode WAR:\r
  15 - change productionMode to true in the servlet class configuration (nested in the UI class)\r
  16 - run "mvn clean package"\r
  17 - test the war file with "mvn jetty:run-war"\r
  18 \r
  19 Client-Side compilation\r
  20 -------------------------\r
  21 \r
  22 The generated maven project is using an automatically generated widgetset by default.\r
  23 When you add a dependency that needs client-side compilation, the maven plugin will\r
  24 automatically generate it for you. Your own client-side customizations can be added into\r
  25 package "client".\r
  26 \r
  27 Debugging client side code\r
  28   - run "mvn vaadin:run-codeserver" on a separate console while the application is running\r
  29   - activate Super Dev Mode in the debug window of the application\r
  30 \r
  31 Developing a theme using the runtime compiler\r
  32 -------------------------\r
  33 \r
  34 When developing the theme, Vaadin can be configured to compile the SASS based\r
  35 theme at runtime in the server. This way you can just modify the scss files in\r
  36 your IDE and reload the browser to see changes.\r
  37 \r
  38 To use the runtime compilation, open pom.xml and comment out the compile-theme\r
  39 goal from vaadin-maven-plugin configuration. To remove a possibly existing\r
  40 pre-compiled theme, run "mvn clean package" once.\r
  41 \r
  42 When using the runtime compiler, running the application in the "run" mode\r
  43 (rather than in "debug" mode) can speed up consecutive theme compilations\r
  44 significantly.\r
  45 \r
  46 It is highly recommended to disable runtime compilation for production WAR files.\r
  47 \r
  48 Using Vaadin pre-releases\r
  49 -------------------------\r
  50 \r
  51 If Vaadin pre-releases are not enabled by default, use the Maven parameter\r
  52 "-P vaadin-prerelease" or change the activation default value of the profile in pom.xml .\r