Skip to content
This repository has been archived by the owner on May 25, 2023. It is now read-only.

Latest commit

 

History

History
56 lines (31 loc) · 3.17 KB

intellij-setup.md

File metadata and controls

56 lines (31 loc) · 3.17 KB
Raw

ODK Aggregate - IntelliJ Setup

IntelliJ can import Gradle projects selecting their root build.gradle file.

Make sure you check Use auto-import option in the Import Project from Gradle dialog.

Once IntelliJ opens your Aggregate project, you can optionally follow any on-screen popups to configure any detected GWT, Spring or web Facets.

Be sure to read other guides before continuing:

Running and debugging Aggregate for development purposes

Aggregate leverages Gradle's Gretty plugin to start an embedded Jetty or Tomcat instance with Aggregate. Warning: This is not intended to be used as a real production server.

Running Aggregate

Start a development Aggregate instance by executing the appStartWar Gradle task. If you need help to run Gradle tasks, please, read the Using the Gradle Command-Line.

Important: Be sure to run the appStop Gradle task to stop a running instance. This will prevent problems with hung Tomcat/Jetty processes.

You should now be able to browse http://localhost:8080

Debugging Aggregate

Start a development Aggregate instance in debug mode by executing the appStartWarDebug Gradle task. If you need help to run Gradle tasks, please, read the Using the Gradle Command-Line.

Important: Be sure to run the appStop Gradle task to stop a running instance. This will prevent problems with hung Tomcat/Jetty processes.

The launch process will then wait for a debugging session to be connected to the embedded server's JVM debugging listener running on port 5005.

To do so, create a new Remote Run/Debug configuration in IntelliJ. The default values will work but make sure that Search sources using module's classpath is set to aggregate (or the name you gave to your module while creating your IntelliJ project). Give it a name and click OK.

Now select the newly created Remote Run/Debug configuration and click on the debug button next to it.

A debugger session will connect to the debugging listener port and Aggregate will launch.

You should now be able to browse http://localhost:8080

Running/Debugging in other host/ip address

By default, Gretty will launch a server using localhost but while working on Aggregate it's often required to run it on a host/ip address accessible from your local area network or even from the Internet (e.g. to be able to send form submissions from an ODK Collect app).

This is achieved by changing your configuration in two places:

  • src/main/resources/security.properties: change the key security.server.hostname to whatever you need
  • build.gradle: change the value for host inside the gretty block accordingly.

Both values must be the same.