Difference between revisions of "Developing with Eclipse"
Jump to navigation
Jump to search
(Draggable quick-install links for marketplace.) |
|||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
==Prerequisites== | ==Prerequisites== | ||
| − | BaseX is developed with the Eclipse environment (other IDEs like IntelliJ IDEA can be used as well). The [https://www.eclipse.org/downloads/ Eclipse IDE for Java Developers] includes the EGit plugin (for [[Git]]) and the m2e plugin (for [[Maven]]). | + | BaseX is developed with the Eclipse environment (other IDEs like IntelliJ IDEA can be used as well). The [https://www.eclipse.org/downloads/ Eclipse IDE for Java Developers] includes the EGit plugin (for [[Git]]) and the m2e plugin (for [[Maven]]). Other plugins we use are: |
| − | |||
| − | Other | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 19: | Line 17: | ||
| Enforces Checkstyle coding standards. | | Enforces Checkstyle coding standards. | ||
| <code><nowiki>http://eclipse-cs.sf.net/update/</nowiki></code> | | <code><nowiki>http://eclipse-cs.sf.net/update/</nowiki></code> | ||
| − | | [ | + | | [https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=150 install] |
|- | |- | ||
| − | | [ | + | | [https://spotbugs.github.io/ SpotBugs] |
| Analyze project at byte code level | | Analyze project at byte code level | ||
| − | | <code><nowiki> | + | | <code><nowiki>https://spotbugs.github.io/eclipse/</nowiki></code> |
| − | | [ | + | | [https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=3519199 install] |
|- | |- | ||
| [http://www.ucdetector.org/ UCDetector] | | [http://www.ucdetector.org/ UCDetector] | ||
| Unnecessary code detector | | Unnecessary code detector | ||
| <code><nowiki>http://ucdetector.sourceforge.net/update</nowiki></code> | | <code><nowiki>http://ucdetector.sourceforge.net/update</nowiki></code> | ||
| − | | [ | + | | [https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=661 install] |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
| Line 41: | Line 34: | ||
Our [[Git|Git Tutorial]] explains how BaseX can be checked out from the [https://github.com/BaseXdb/basex GitHub Repository] and embedded in Eclipse with EGit. The article also demonstrates how git can be used on command-line. | Our [[Git|Git Tutorial]] explains how BaseX can be checked out from the [https://github.com/BaseXdb/basex GitHub Repository] and embedded in Eclipse with EGit. The article also demonstrates how git can be used on command-line. | ||
| − | The basex repository contains the following | + | The basex repository contains the following subdirectories: |
# {{Code|basex-core}} is the main project | # {{Code|basex-core}} is the main project | ||
# {{Code|basex-api}} contains the BaseX APIs (XML:DB, bindings in other languages) and HTTP Services ([[REST]], [[RESTXQ]], [[WebDAV]]) | # {{Code|basex-api}} contains the BaseX APIs (XML:DB, bindings in other languages) and HTTP Services ([[REST]], [[RESTXQ]], [[WebDAV]]) | ||
| Line 47: | Line 40: | ||
# {{Code|basex-tests}} contains several unit and stress tests | # {{Code|basex-tests}} contains several unit and stress tests | ||
| − | If the "Problems" View contains errors or warnings, you may need to switch to Java | + | If the "Problems" View contains errors or warnings, you may need to switch to Java 11 (''Windows'' → ''Preferences'' → ''Java'' → ''Installed JREs''). |
==Start in Eclipse== | ==Start in Eclipse== | ||
| − | # Press ''Run'' → '' | + | |
| + | # Press ''Run'' → ''Run…'' | ||
# Create a new "Java Application" launch configuration | # Create a new "Java Application" launch configuration | ||
# Select "basex" as "Project" | # Select "basex" as "Project" | ||
| Line 58: | Line 52: | ||
==Alternative== | ==Alternative== | ||
| − | You may as well use the standalone version of [[Maven]] to compile and run the project, use other IDEs such as [ | + | You may as well use the standalone version of [[Maven]] to compile and run the project, use other IDEs such as [https://www.jetbrains.com/idea/ IntelliJ IDEA]. |
| − | |||
[[Category:Developer]] | [[Category:Developer]] | ||
Latest revision as of 15:09, 29 July 2022
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.
Prerequisites[edit]
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. | http://eclipse-cs.sf.net/update/
|
install |
| SpotBugs | Analyze project at byte code level | https://spotbugs.github.io/eclipse/
|
install |
| UCDetector | Unnecessary code detector | http://ucdetector.sourceforge.net/update
|
install |
Check Out[edit]
Our Git Tutorial explains how BaseX can be checked out from the GitHub Repository and embedded in Eclipse with EGit. The article also demonstrates how git can be used on command-line.
The basex repository contains the following subdirectories:
basex-coreis the main projectbasex-apicontains the BaseX APIs (XML:DB, bindings in other languages) and HTTP Services (REST, RESTXQ, WebDAV)basex-examplesincludes some examples code for BaseXbasex-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[edit]
- 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
Alternative[edit]
You may as well use the standalone version of Maven to compile and run the project, use other IDEs such as IntelliJ IDEA.
