Page Comparison

Table of Contents

UI Development

1. Install Eclipse Helios Eclipse Juno (v3v4.62)
2. Install Google Web Toolkit, Google App Engine SDK, and Google plug-in for Eclipse using Eclipse new software from Google's update site - http://dl.google.com/eclipse/plugin/3.6.  Note if you were using an older version of this plugin you will need to uninstall it and then re-install it to ensure it has GWT 2.4.0 support.
3. Install the Maven2Eclipse plugin: http://download.eclipse.org/technology/m2e/releases
4. Install the EGit eclipse plugin: http://www.eclipse.org/egit/download/
5. Create a GitHub user account
   
   1. Internal Sage developers will be added as a developer on the project and will be able to push directly
   2. External contributors should fork the repository and submit GitHub Pull Requests for code inclusion
6. Set up Git: https://help.github.com/articles/set-up-git

7. Fork the Sage-Bionetworks SynapseWebClient repository into your own GitHub account: https://help.github.com/articles/fork-a-repo

8. Clone the SynapseWebClient project down to your computer: git clone https://github.com/[YOUR GITHUB NAME]/SynapseWebClient.git
9. Import the project as a maven project
   
   1. File -> Import -> Maven -> Existing Maven Projects
   2. Next, in Root Directory enter the local path to your repository clone
   3. Next, Finish 
10. Enable Git Team tracking
    
    1. Now right click on portal (project name) -> Team -> Share Project
    2. Next, Select repository type Git
    3. Next, Check the box "Use or create repository in parent folder of project
    4. Next, Finish 
11. You need to make sure the GWT xml files are on the classpath. All of these resources can be found in src/main/resources directory. 
    
    1. Right-click on portal (project name) ->Build Path>Configure Build Path...
    2. Remove the "Exclude" filter from the source tab on the src/main/resources directory
12. We need to tell the GWT Eclipse-plugin that this is a GWT project. Do this by Right-Clicking on the project in the package explorer and select: Google->Web Toolkit Settings...
    
    1. From the resulting dialog make sure the "Use Google Web Tookit" check box is selected.
    2. Also make sure you are using GWT 2.4.0.
13. We need to tell the Google plugin where our web app directory can be found.  Right-click on the project in the package explorer and select Properties.
    
    1.  From the tree on the left of the dialog navigate to Google->Web Application
    2. Check the the check box: "This project has a WAR directory"
    3. With the "Browse" button, select "src/main/webapp"
    4. UN-CHECK the "Launch and deploy from this directory"  This is very important, if you keep this checked then Maven will not be able to generate a clean WAR file.  If you see "GWT needs to recompile" when you deploy your WAR then you probably have this box checked.
14. Now that the Portal.gwt.xml file is on the classpath, make sure GWT knows it is the entry point.
    
    1. Right-Click on the project from the package explorer.
    2. Select Google->Web Toolkit Settings...
    3. Under the "entry point modules" you should see "Portal - org.sagebionetworks.web",  if not, then add it with the add button.
15. Now make sure GWT can compile your code
    
    1. Right-Click on the project in the package explorer
    2. Google->GWT Compile
    3. The first time you run this you will be asked to select the output directory where GWT will compile the code. You want this to match the Maven WAR output directory, so use "target/portal-<VERSION>-SNAPSHOT"
16. (Optional) Start the back-end repository services:
    1. The synapse.version tag in root pom.xml has the form 2012-08-06-3e90a85-44, it has the date (2012-08-06) and the first 7 chars of the commit hash, 3e90a85.
    2. Now, from an up-to-date clone of Synapse-Repository-Services on your local box:
    3. git checkout <commit hashcode prefix>
    4. e.g.:
    5.  git checkout 3e90a85
    6. mvn clean install -Dorg.sagebionetworks.database.drop.schema=true
    7. cd integration-test
    8. mvn cargo:run
    9. You will notice that the version in the pom.xml's of the retrieved commit are 'develop-SNAPSHOT' so you must change the 'synapse version' in the portal's pom.xml  to be 'develop-SNAPSHOT' too.
17. The next step creates a Run Configuration. You should modify this configuration to avoid a PermGen OutOfMemoryError 
    (the error is likely due to the gwt development environment, where gwt does not properly gc the classes loaded in the permanent generation area of the heap (that were loaded in a previous run)):
    1. Right-Click on the project in the package explorer.
    2. Select: Run As->Run Configurations...
    3. Select the GWT Web Application run configuration named Portal.html.
    4. Click on the Arguments tab.
    5. In the VM arguments, add "-XX:MaxPermSize=512m"
18. You are finally ready to run the application in development mode.
    
    1. Right-Click on the project in the package explorer
    2. Select: Run As->Web Application
    3. Double-click on the link provided in the Development Mode window to view the portal in your browser.  If you get asked what page to start on choose Portal.html

...