Difference between revisions of "Development:JABAWS"
From Jalview Wiki
(initial and wrong instructions for setting up a JABA development environment) |
(→Getting started with JABAWS development) |
||
| Line 13: | Line 13: | ||
# Get your JABAWS development environment set up. | # Get your JABAWS development environment set up. | ||
#* Unfortunately, we don't have full instructions on this. *Sasha and I will put up something on the wiki shortly.* | #* Unfortunately, we don't have full instructions on this. *Sasha and I will put up something on the wiki shortly.* | ||
| − | # | + | #: For the moment, the rough instructions are: |
## Make sure you have a full installation of Apache Tomcat7 on your machine. | ## Make sure you have a full installation of Apache Tomcat7 on your machine. | ||
## In Eclipse, you'll need to add a link to your tomcat7 installation in the 'Runtimes' section of the Servers preferences tab. | ## In Eclipse, you'll need to add a link to your tomcat7 installation in the 'Runtimes' section of the Servers preferences tab. | ||
## Checkout the JABAWS code and import the project to eclipse. | ## 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://www.jalview.org/git/jabaws.git # 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 principal, 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. | ||
# 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}. | # 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}. | ||
Revision as of 11:08, 25 April 2014
Getting started with JABAWS development
Here's a work in progress concerning how to get a working development version of JABA on your own machine.
The first steps are:
- Sign up at issues.jalview.org.
- This login is also used for the JABA and Jalview source repositories, and also the Jalview wiki.
- Take a look at our Development general coding guidelines
- Get set up with eclipse.
- I use a third party eclipse system called 'Yoxos' - see Development:Yoxos instructions for setting up Yoxos for Jalview development
- Get your JABAWS development environment set up.
- Unfortunately, we don't have full instructions on this. *Sasha and I will put up something on the wiki shortly.*
- For the moment, the rough instructions are:
- Make sure you have a full installation of Apache Tomcat7 on your machine.
- In Eclipse, you'll need to add a link to your tomcat7 installation in the 'Runtimes' section of the Servers preferences tab.
- 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://www.jalview.org/git/jabaws.git # 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 principal, 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.
- 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}.
