Developing with Eclipse
This page is part of the Developer Section. It describes how to get the BaseX sources compiled and running on your system.
Another article in the documentation describes how to use BaseX as a query processor in Eclipse.
BaseX is developed with the Eclipse environment (other IDEs like IntelliJ IDEA can be used as well). The Eclipse IDE for Java Developers includes the EGit plugin (for Git) and the m2e plugin (for Maven). Other plugins we use are:
|Name||Description||Update URL||Eclipse Marketplace|
|eclipse-cs||Enforces Checkstyle coding standards.||
|SpotBugs||Analyze project at byte code level||
|UCDetector||Unnecessary code detector||
The basex repository contains the following subdirectories:
basex-coreis the main project
basex-apicontains the BaseX APIs (XML:DB, bindings in other languages) and HTTP Services (REST, RESTXQ, WebDAV)
basex-examplesincludes some examples code for BaseX
basex-testscontains several unit and stress tests
If the "Problems" View contains errors or warnings, you may need to switch to Java 11 (Windows → Preferences → Java → Installed JREs).
Start in Eclipse
- Press Run → Run…
- Create a new "Java Application" launch configuration
- Select "basex" as "Project"
- Choose a "Main class" (e.g.,
org.basex.BaseXGUIfor the graphical user interface)
- Launch the project via Run