Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
minLevel3

...

  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
      languagexml
      titlesettings.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> <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'

...

...

Note that emails will not be sent when pointing to a local repo, the SynapseEmailService will instead write files to the devdata.sagebase.org s3 bucket in format <to_email_address>.json

...

Set the repository endpoint parameters in your maven settings.xml file by adding the following properties (update the values to match the stack that you want to point to):

...

.xml file. 

To point to staging set:

<org.sagebionetworks.

...

<org.sagebionetworks.stack>prod</org.sagebionetworks.stack>

...

repositoryservice.endpoint>https://repo-staging.prod.sagebase.org/repo/v1</org.sagebionetworks.

...

repositoryservice.endpoint>

To point to production set:

<org.sagebionetworks.
portal
repositoryservice.endpoint>
http12700.1:8888/Portal.html<portalendpoint>

Restart the Portal app to load these properties this property from settings.xml.

Documenting complicated UI in the code

...