Difference between revisions of "Developing with Eclipse"

From BaseX Documentation
Jump to navigation Jump to search
Line 17: Line 17:
 
The following repositories are available:
 
The following repositories are available:
 
# [https://github.com/BaseXdb/basex basex] is the main project
 
# [https://github.com/BaseXdb/basex basex] is the main project
# [https://github.com/BaseXdb/basex-api basex-api] contains the BaseX APIs (REST, RESTXQ, WebDAV, XQJ, XMLDB, and bindings in other languages)  
+
# [https://github.com/BaseXdb/basex-api basex-api] contains the BaseX APIs (XQJ, XMLDB, and bindings in other languages) and HTTP Services (REST, RESTXQ, WebDAV)  
 
# [https://github.com/BaseXdb/basex-examples basex-examples] includes some examples code for BaseX
 
# [https://github.com/BaseXdb/basex-examples basex-examples] includes some examples code for BaseX
 
# [https://github.com/BaseXdb/basex-tests basex-tests] contains several correctness and stress tests
 
# [https://github.com/BaseXdb/basex-tests basex-tests] contains several correctness and stress tests

Revision as of 19:57, 22 March 2012

This page is part of the Developer Section. It describes how to get the BaseX sources compiled and running on your system.

Prerequisites

  • 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.

You may as well use the standalone version of Maven to compile and run the project.

Check Out

To get some help on how to check out BaseX and its sub projects from the GitHub Repositories, and how to optionally use BaseX on command line, please have a look at our Git Tutorial.

The following repositories are available:

  1. basex is the main project
  2. basex-api contains the BaseX APIs (XQJ, XMLDB, and bindings in other languages) and HTTP Services (REST, RESTXQ, WebDAV)
  3. basex-examples includes some examples code for BaseX
  4. basex-tests contains several correctness and stress tests

Start in Eclipse

  1. Press RunRun…
  2. Create a new "Java Application" launch configuration
  3. Select "basex" as "Project"
  4. Choose a "Main class" (e.g., org.basex.BaseXGUI for the graphical user interface)
  5. Launch the project via Run