Difference between revisions of "Development:JABAWS:GettingStarted"

Revision as of 22:22, 27 April 2014

Here's a work in progress concerning how to get a working development version of JABA on your own machine.

The first steps are:

1. Sign up at issues.jalview.org.
   • This login (your dev credentials) is also used for the JABAWS, Jalview and ProteoCache source repositories, and also the Jalview wiki.
2. Take a look at the general coding guidelines on the Development page.
3. Get set up with eclipse.
   • I use a third party eclipse system called 'Yoxos' - see Development:Yoxos to set this up.
   • a standard Eclipse pack for "Java EE Developers" may also be used (see details at [[1]])
   • Install and add to Eclipse the last Java 6 JDK.
4. Install and configure Apache Tomcat
   • it is safer to use the last Tomcat 7 version, we haven't tested JABAWS with Tomcat 8.x yet...
   • Register your Tomcat installation in Eclipse
5. Get your JABAWS development environment set up.
   1. Make sure you have a full installation of Apache Tomcat7 on your machine.
   2. In Eclipse, you'll need to add a link to your tomcat7 installation in the 'Runtimes' section of the Servers preferences tab.
   3. Checkout the JABAWS code and import the project to eclipse.

      i. clone the jabaws repository to somewhere on your laptop (~/git/ is always a good place to store git repos!)

      git clone https://source.jalview.org/git/jabaws.git # you will need your dev credentials for this. Currently the repository is ~1.3Gb, so this will take some time

      ii. switch to the develop branch, which includes the latest version of JABAWS (we'll release this as JABAWS 2.1).

      cd jabaws

      git checkout develop

      iii. Import the project to eclipse

      Use eclipse's File->Import dialog to select the 'Import projects from git repository' wizard, and point it at your local version of the JABAWS repository. Import the project called 'clustengine'

      iv. Try to run the project to launch a jabaws development server

      In principle, you'll then be able to right-click on the new clustengine project and select 'Run -> Run on Server' to get JABAWS running on a local tomcat instance. However, you'll almost certainly need to fix some paths.

6. Further reading: there are details on the jabaws-dev server that give some more {{http://www.compbio.dundee.ac.uk/jabaws-dev/man_server_dev.html background about jabaws development}.