Skip to content

Home

Jump to bottom Edit New page
rkboyce edited this page Jul 3, 2013 · 25 revisions

Welcome to the DomeoClient wiki!

Setting up the DomeoClient development environment

DomeoClient is a project that enables targeted development of the annotation tool within the Domeo framework. Instructions for setting up the development project are below.

Overview of the architecture and development workflow

DomeClient uses the Google Web Toolkit (GWT) and the Apache Spring framework. As as result, it is best to download and install the SpringSource STS IDE.

DomeoClient can be ran in two modes:

  1. hosted mode: The STS IDE runs a server that services the Domeo.HTML page, servlets with services mockups and the compiled GWT code. When you load Domeo.html in the browser the first time you will notice a 10 seconds delay as it is compiling all the Java code into Javascript. The hosted mode is helpful as basically you are running the GWT without the need to spin up an entire server. Most importantly, through the GWT browser plugin, you get incremental compilation of the GWT Jave code into JS. So every time you change some code, a reload is sufficient to test the new lines (see the compiled mode to notice the difference). Once the hosted mode is running, one can use an empty scaffolding to develop plugins (more directions pending).

  2. compiled mode: This is the mode that is used when the application is deployed in a real setting. It requires a full compilation of the code. As GWT compiles for all possible browsers, the compilation process might take up to 5 minutes according to the power of your machine. As you c1an imagine you don't want to do that when developing as you would spend more time compiling than writing code. When your plugin will be in a good shape in the 'hosted mode' you would make sure the little details for running also in the 'compile mode' are taken care of and then compile the project and link it into the larger Domeo framework (instructions pending).

Instructions for setting up the environment

  1. install STS SpringSource STS IDE. The plain STS download will work (e.g., Spring Tool Suite 3.2.0.RELEASE - based on Eclipse Juno 3.8.2) but you can also use "Groovy and Grails tool suite (ggts) install the STS plugin for Eclipse.

  2. Once STS is installed you need to open the "Dashboard", go to the "Extensions" tab, and search for the Google GWT plugin

  3. download GWT version 2.4.0

  4. link the GWT 2.4.0 version to the plugin usnig STS/Eclipse preferences (usually Window --> Preferences --> Google --> Web Toolkit).

TODO: screenshot

  1. clone the DomeoClient codebase (i.e., from the commandline: git clone https://github.com/domeo/DomeoClient.git

  2. import the project in the Eclipse/STS workspace using File --> Import --> General --> Import Existing Projects Into Workspace.

  3. Install the GWT Developer Toolkit into your browser (Firefox or Chrome)

  4. Find Domeo.html in the package explorer (DomoeClient --> war --> WEB-INF --> Domeo.html) and run as 'Web Application' (by right clicking over the file name and going Run As --> Web Application)

  5. After some time, the "console" will display a link that has to be opened in your browser (Firefox or Chrome). The link should look like:

http://127.0.0.1:8888/Domeo.html?gwt.codesvr=127.0.0.1:9997

  1. After ~1 minute or less, you should see the Annotator window for Domeo in your browser.

TODO: screenshot and rules for working with the mode

Add a custom footer
Add a custom sidebar
Clone this wiki locally