Skip to content

Setting up deegree3 in your IDE

tfr42 edited this page Jun 5, 2023 · 27 revisions

This page describes how you can load the deegree sources into your favorite IDE.

Eclipse

Tested version: Eclipse EE 4.3.1

NOTE: Currently, it is not recommended to use the m2eclipse builder with deegree3 -- it chokes on the number of modules and not all Maven plugins used by deegree3 are supported. Therefore, the recommended workflow to get deegree3 working in Eclipse is:

  • Clone the deegree3 repository
  • Run Maven's Eclipse plugin
  • Import the deegree3 clone directory in Eclipse

Clone the deegree3 repository

First, clone the deegree3 repository to a local directory and check out the version that you want to work on. See Building deegree3 for details.

NOTE: Don't use m2eclipse functionality like "Checkout Maven Projects from SCM" or "Materialize Maven Projects from SCM" for cloning. It would automatically activate the m2eclipse builder.

Run Maven's Eclipse plugin

On the command line, change to your clone directory and run the following command (you need to have Apache Maven 3 installed):

mvn eclipse:clean eclipse:configure-workspace eclipse:eclipse -Dwtpversion=2.0

The command will create Eclipse config files (.classpath, .project, .settings) for all deegree modules and also apply several settings (e.g formatters) to your Eclipse workspace.

Import the deegree3 repository directory

In Eclipse, select "File" -> "Import..." -> "Existing Projects into Workspace" -> "Next". Click "Browse..." and select the deegree3 repository directory. Click "OK" and "Finish". After a while, you should have all deegree3 modules compiled in Eclipse without any errors.

If you want to run deegree-webservices inside Eclipse: Right click on the "deegree-webservices" project and select "Run As" -> "Run on Server".

Use the formatter

You can enable the formatter in Eclipse IDE. The easiest way is to follow the documentation here.

IntelliJ IDEA

Clone the deegree3 repository

First, clone the deegree3 repository to a local directory and check out the version that you want to work on. See Building deegree3 for details.

Import the deegree3 project sources

In IntelliJ IDEA, navigate to "File" -> "New" -> "Project From Existing Sources...", choose the folder containing the deegree sources and click on "Open". In the next window choose "Import project from external model" and "Maven". Continue with "Next" and in the next window select "Import Maven projects automatically". The next windows do not need any configuration. Start the import after clicking on "Finish".

Use the formatter

As of deegree 3.5 the code is formatted by the spring-javaformat. You can enable it in IntelliJ IDEA. So the easiest way is to follow the documentation here.

Clone this wiki locally