wiki:Devel/Setup

Context Navigation

Version 25 (modified by leo, 18 years ago) (diff)
--

wiki:Devel/Index

Guides for Developers

Source Code Repository

Subversion: http://svn.utgenome.org/utgb/trunk/utgb

Checkout http://svn.utgenome.org/utgb/trunk/utgb folder

   svn checkout http://svn.utgenome.org/utgb/trunk/utgb utgb

This operation will download the following folders

maven
utgb-common
utgb-core
utgb-medaka
utgb-mmdb
utgb-gallery

Development with Eclipse

Download Eclipse
Install Subclipse (or Subversive) plug-in.
- Eclipse -> Help -> Software Updates -> Find/Install? -> (Select "Search new features to install") -> (Push "New Remote Site")
  - add http://subclipse.tigris.org/update_1.0.x or
  - http://subclipse.tigris.org/update_1.2.x (Eclipse 3.2~)
Install Q4E plugin (maven plugin): update site http://q4e.googlecode.com/svn/trunk/updatesite/
- Installation notes: http://code.google.com/p/q4e/wiki/Installation

Open the SVN Repository Explorer perspective, then add new remote site, http://dev.utgenome.org/svn/utgb.
Checkout the http://svn.utgenome.org/utgb/trunk/utgb/utgb-core folder as an Eclipse (or Maven2) project.

Installing GWT

(The following process is no longer required since maven plug-in automatically downloads necessary libraries.)

Download the latest version of Google Web Toolkit, matching your OS environment.
- http://svn.utgenome.org/utgb/trunk/archive/gwt
Expand the archive, for example, c:\home\leo\local\gwt-win-1.4.10
Set the class path variable named GWT_HOME in your Eclipse (Window -> Preferences -> Java -> Build Path -> Classpath):
```
GWT_HOME=(your GWT installation folder)
```

Launch the GWT Develpment Shell

Click the side-cursor on the Debug botton, then select "GenomeBrowser_gwt_shell"
GWT Shell Window and Hosted-mode browser, which is exactly IE plug-in (in Windows), will open after 10~30 seconds.

Other Useful Plug-ins for Eclipse

Mylyne
- Update site: (for Eclipse 3.2) http://download.eclipse.org/tools/mylyn/update/e3.2
- Task-oriented development support utilities with Trac Ticket/Wiki? view, modify, query facilities.

FatJar
- Packs all required Jar files into a single Jar file.

Buckminster
- required to install Subclipse & Mylyn integration feature

Ruby Development Toolkit

My bookmarks.xml for Eclipse3.2

<?xml version="1.0" encoding="UTF-8"?>
<bookmarks>
   <site name="Subclipse" url="http://subclipse.tigris.org/update_1.2.x" web="false" selected="true" local="false"/>
   <site name="fatjar" url="http://kurucz-grafika.de/fatjar" web="false" selected="true" local="false"/>
   <site name="Mylar" url="http://download.eclipse.org/technology/mylar/update-site/e3.2" web="false" selected="true" local="false"/>
   <site name="The Eclipse Project Updates" url="http://update.eclipse.org/updates/3.2" web="false" selected="false" local="false"/>
   <site name="Callisto Discovery Site" url="http://download.eclipse.org/callisto/releases" web="false" selected="false" local="false"/>
</bookmarks>

The following contents are retrieved from trunk/browser/README:

Build & Debug (with Eclipse)

Install GWT (Google Web Toolkit. version 1.4.10 or higher)
In Window->Preference->Java->Classpath Variables, add a new variable as follows:
```
GWT_HOME=(your GWT installation folder)
```
(debug) launch Debug -> GenomeBrowser_gwtshell, which displays GWT debug shell and

genome browser interface.

Build (from command line)

Download the Google Web Toolkit from the web. Version 1.4.10 or higher is required.
Copy 'build.properties.sample' to 'build.properties'
Open the 'build.property' file, then change the gwt.home variable to the path of your GWT (Google Web Toolkit) folder, and comment out appropriate 'gwt.dev' lines to select GWT develeopement library on your OS. - e.g. (in Windows)
```
gwt.home=C:/(somewhere in your PC)/gwt-windows-1.4.10
gwt.dev=gwt-dev-windows.jar
#gwt.dev=gwt-dev-mac.jar
#gwt.dev=gwt-dev-linux.jar
```
```
> ant compileJs
```
Open www/org.utgenome.gwt.utgb.UTGB/UTGB.html in your web browser (IE, Firefox, etc.)

Deploy

Install Tomcat 5.0 (or higher) Java web server.

Edit your build.properties file, and modify the following variables:

TOMCAT_HOME=(Tomcat Installation folder)
tomcat.base.url=http://localhost:8080
tomcat.manager.username=(tomcat manager username)
tomcat.manager.password=(tomcat manager password)

Set up GWT as described above (the section on build from command line)
```
> ant deploy
```

This generates a war file (web application archive), and deploy the war file in the tomcat server

Trouble Shooting

Q: GWT Shell invokes a following error:

[ERROR] Errors in 'jar:file(...)UTGB%20Common/lib/gwt-dragdrop-1.0RC.jar!/com/allen_sauer/gwt/dragdrop/client/DeferredMoveCommand.java'

A: Your GWT version must be higher than 1.4.10 in order to use drag & drop facility.

Q: out of memory error when running Ant.
- A: create a $HOME/.ant/ant.conf file, then write the following line:
```
ANT_OPTS="-Xmx512M"
```