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 being developed with the Eclipse environment. Other IDEs are used as well in our community, but are not supported by our team.
- The EGit plugin can be used to check out the latest sources from our repository within Eclipse.
- The m2eclipse plugin is required to work with packages other than the main project; it adds Maven support to Eclipse.
- Additional coding guidelines are defined via Checkstyle and can be integrated with the eclipse-cs plugin.
- Other Eclipse plugins we frequently use are FindBugs to analyze Java byte code, and Core Tools to find unreferenced members.
The following repositories are available:
- basex is the main project
- basex-api contains the BaseX APIs (XML:DB, bindings in other languages) and HTTP Services (REST, RESTXQ, WebDAV)
- basex-examples includes some examples code for BaseX
- basex-tests contains several correctness and stress tests
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
You may as well use the standalone version of Maven to compile and run the project, or other IDEs such as [www.jetbrains.com/idea IntelliJ IDEA].