Page Comparison

Table of Contents

...

1. Install Eclipse
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/4.2.  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. Another note: Installing 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. (Optional) 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. 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 
8. (Optional) 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 
9. 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.
10. 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 (or 2.5.1).
11. 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.
12. 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.
13. 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"
    4. 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.
14. 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
    4. If you get a 404 error, you may need to navigate to the project root directory and "mvn clean install".

...

As of Chrome version 39, the old GWT Development Mode is no longer available.
Using Super Dev Mode (SDM) means running two servers, one for the web application and one for the Code Server that compiles classes for SDM when the compile button is pushed on the web page or in the bookmark.

First thing to do is to make sure that your Google Plugin for Eclipse is up to date (version >=  3.8.0.v201410302155-rel-r42).
NOTE: After we update to GWT v2.6 or greater, this section needs to be rewritten (can be a single launch configuration if using GWT 2.6).

• In your existing web application Portal launch configuration (created in the previous section above), add the following to the VM Arguments: "-Xmx512m -XX:MaxPermSize=512m -Dgwt.codeserver.port=9876"

...

• Missing jars in your WEB-INF/lib directory (the maven dependencies)?  Go to the command line and run: "mvn eclipse:eclipse -Dwtpversion=2.0" to automatically add these libraries to the Deployment Assembly.  After running this command, you may get this error in Eclipse: "Java compiler level does not match the version of the installed Java project facet." If so, bring up the Portal project Properties, select Project Facets from the list, and fix the Java version. "mvn clean install" from command line, then change your Run Configuration->Arguments->Working Directory to Other, pointing to ${workspace_loc:portal/target/portal-develop-SNAPSHOT}
  
• Serialization problems? Due to this known issue that applies to GWT v2.5.1, you should always run the Code Server first, then start the Portal web application once the code server is available. We now copy over gwt.rpc files on servlet init as a workaround until we upgrade to GWT v2.6.

...