README.md

   1 ## Available UIs
   2
   3 * http://localhost:8080/app/concept
   4 * http://localhost:8080/app/distribution
   5 * http://localhost:8080/app/account
   6 * http://localhost:8080/app/registration
   7
   8 ## Architecture of this Vaadin project
   9
  10 see [Model-View-Presenter-MVP-Pattern](https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/VaadinNotes#Model-View-Presenter-MVP-Pattern)
  11
  12 ## Developer
  13
  14 ### Eclipse IDE
  15
  16 It is recommended to use the [Spring Tool Suite](https://spring.io/tools).
  17
  18 Make sure you have the **Maven2Eclipse** plugin installed.
  19
  20 In addition you will need the **Vaadin Eclipse Plugin** which can be installed via the Marketplace:
  21
  22 ![](images/Vaadin-Plugin-for-Eclipse.png)
  23
  24 For working the the UI designs it is recommendet to install the Vaddin Designer for Vaadin 7.
  25
  26 ### Project setup with maven
  27
  28 ~~~
  29 mvn clean install
  30 ~~~
  31
  32 other useful [vaadin plugin commands](https://gwt-maven-plugin.github.io/gwt-maven-plugin/plugin-info.html)
  33
  34 ~~~
  35 mvn vaadin:clean
  36 mvn vaadin:update-theme
  37 mvn vaadin:update-widgetset
  38 mvn vaadin:compile
  39 mvn vaadin:compile-theme
  40 ~~~
  41
  42
  43 ### Configure vaadin UIs for a specific cdm data source
  44
  45 On the fist application startup on a cdm data source the `eu.etaxonomy.cdm.addon.config.CdmVaadinConfiguration` will create a `vaadin-apps.properties` file in the cdm source specific configuration folder: `~/.cdmLibrary/remote-webapp/${cdm-source-bean-id}/`
  46
  47 The default content of this file defined in `eu.etaxonomy.cdm.addon.config.CdmVaadinConfiguration.APP_FILE_CONTENT` at the time of writing this documentation is :
  48
  49 ~~~
  50 ################################################################
  51 #
  52 # Vaadin application specific configurations
  53 #
  54 ################################################################
  55
  56 # Enablement of vaadin uis.
  57 #
  58 # Multiple uis can be defined as comma separated list.
  59 # Whitespace before and after the comma will be ignored.
  60 # Valid values are the path properties of the @SpringUI
  61 # annotation which is used for UI classes.
  62 cdm-vaadin.ui.activated=account,concept,distribution,editstatus
  63 ~~~
  64
  65 There are more UIs that can be activated by adding them to the `cdm-vaadin.ui.activated` property.
  66 For example to enable the `RegistrationUI` you will need to add the name defined in `eu.etaxonomy.cdm.vaadin.ui.RegistrationUI.NAME`:
  67
  68 ~~~
  69 cdm-vaadin.ui.activated=account,concept,distribution,editstatus,registration
  70 ~~~
  71
  72 ### Auto login into the vaadin application
  73
  74 For development it can be convenient to enable the automatic login.
  75 To enable this feature you will need to supply the following system properties:
  76
  77 ~~~
  78 -Dcdm-vaadin.login.usr=username
  79 -Dcdm-vaadin.login.pwd=password
  80 ~~~
  81
  82 #### Setup Selenium based UI tests
  83
  84 **NOTE**: The framework to run Selenium tests on vaadin apps is not yet ready for use.
  85
  86 * Run a `clean install` goal to download the Selenium drivers