Page Comparison

Table of Contents
minLevel 3

...

1. Download IntelliJ community edition, it comes pre-built with GWT and Maven support. 
2. Install GWT SDK (install the actual SDK, not the eclipse plugin version)
   1. If downloading Java for the first time then download Java 8 as well.
3. If you want to run Maven manually then install it from here (this will require you to add the mvn installation directory to your PATH as well), otherwise see notes here on configuring IntelliJ to run maven build.
4. Configure settings.xml –- its a configuration file for running maven
   1. The file needs to placed in $HOME/.m2/settings.xml (e.g. michael/.m2/settings.xml)

   2. The template for the file needs to look like so-

      Code Block
      language xml title settings.xml
      <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> <localRepository/> <interactiveMode/> <usePluginRegistry/> <offline/> <pluginGroups/> <servers/> <mirrors/> <proxies/> <profiles> <profile> <id>dev-environment</id> <activation> <activeByDefault>true</activeByDefault> </activation> <properties> <org.sagebionetworks.portal.endpoint>http://127.0.0.1:8888/Portal.html</org.sagebionetworks.portal.endpoint> <!-- insert properties described below here --> </properties> </profile> </profiles> <activeProfiles/> </settings>

      
      

5. Import the SWC into IntelliJ by File → New Project From Existing Sources... <Select Path to SWC Location>
6. If running Maven manually run like so (see note below on saving build time by running in debug mode):
   1. Run 'mvn clean install'
   2. Run 'mvn gwt:run'

Set up the Eclipse Build

1. Install Eclipse (Mars 4.5, Neon 4.6 GWT super dev mode does not start properly)latest Eclipse
2. Install Google Web Toolkit, Google App Engine SDK, and Google plugthe Google Plug-in for Eclipse using Eclipse new software from Eclipse http://www.gwtproject.org/download.html.  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.8 beta1 support. Another note: Installing Do not include GWT SDK in the install (GWT SDK will be installed by the maven install).  Do not install the Google App Engine Maven Integration software made Eclipse error when building the SynapseWebClient. It would not work until I uninstalled it.
3. Install the Maven2Eclipse plugin: http://download.eclipse.org/technology/m2e/releases
4. Create a GitHub user account
   
   1. Contributors should fork the repository and submit GitHub Pull Requests for code inclusion.

5. Set up Git: https://help.github.com/articles/set-up-git

6. 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 
7. You need to make sure the GWT xml files are on the classpath. All of these resources can be found in src/main/resources and src/test/resources directories. 
   
   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 and src/test/resources directories.
8. 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 TookitToolkit" check box is selected.
   2. Also make sure you are using GWT 2.8 beta1the GWT SDK from your local maven repository (.m2/repository/com/google/gwt)
9. 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.
10. Now make sure GWT can compile your code
    
    1. Right-Click on the project from the package explorer.
    2. Select Google→GWT Compile...
    3. Under the "Entry Point Modules" you should see "PortalDebug - org.sagebionetworks.web",  if not, then add it with the add button.
    4. Remove the "Portal - org.sagebionetworks.web" entry.
    5. 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"
    6. If you get compilation errors from the JavaScript validator (i.e. NullPointerException), navigate to the project's properties → JavaScript → Include Path → Source, and exclude all files from the source. If an OutOfMemoryError was thrown while compiling, you can click the "Advanced" tab towards the bottom of the Google → GWT Compile window and add "-Xms512M -Xmx1524M" to the VM arguments to increase heap space.
11. If the GWT Compile successfully compiled, then you're ready to run the application.
    
    1. Option 1: start from within Eclipse.
       1. Right-Click on the project in the package explorer
       2. Select: Run As → Web Application ( GWT Super Dev Mode)Development Mode with Jetty, and select Portal.html
       3. Set the run configuration VM Arguments to the following: "-XX:MaxPermSize=512m -Xms512m -Xmx2048m -XstartOnFirstThread".  Also look at your eclipse.ini file (if launching SDM from Eclipse).
       4. 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. 
    2. Option 2: build and run from the command line.
       1. Run 'mvn clean install'
       2. Run 'mvn gwt:run'

...

Set the repository endpoint parameters in your maven settings.xml file. 

To point to staging set:

To point to production set:

...