Changes

Jump to navigation Jump to search
773 bytes added ,  16:09, 29 July 2022
no edit summary
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 [[Integrating Eclipse|query processor in Eclipse]].
 
==Prerequisites==
* BaseX is being developed with the [http://www.eclipse.org Eclipse] environment. Other (other IDEs are like IntelliJ IDEA can be used as well in our community, but are not supported by our team).* The [httphttps://www.eclipse.org/egitdownloads/ EGitEclipse IDE for Java Developers] plugin can be used to check out includes the latest sources from our repository within Eclipse.* For additional comfort and to work with packages other than the main project, the [http://m2eclipse.sonatype.org m2eclipse] EGit plugin is required, which adds (for [[MavenGit]] support to Eclipse.* Additional coding guidelines are defined via Checkstyle ) and can be integrated with the m2e plugin (for [http://eclipse-cs.sourceforge.net eclipse-cs[Maven]] plugin).* Other Eclipse plugins we frequently use are [http://findbugs.sourceforge.net/ FindBugs] to analyze Java byte code, and [http://wiki.eclipse.org/Core_Tools Core Tools] to find unreferenced members.
You may as well use the standalone version of {| class="wikitable" |- valign="top"! Name! Description! Update URL! Eclipse Marketplace|-| [http://eclipse-cs.sourceforge.net eclipse-cs]| Enforces Checkstyle coding standards.| <code><nowiki>http://eclipse-cs.sf.net/update/</nowiki></code>| [Mavenhttps://marketplace.eclipse.org/marketplace-client-intro?mpc_install=150 install]|-| [https://spotbugs.github.io/ SpotBugs] to compile and run the | Analyze projectat byte code level| <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]| Unnecessary code detector| <code><nowiki>http://ucdetector.sourceforge.net/update</nowiki></code>| [https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=661 install]|}
==Check Out==
To get some help on Our [[Git|Git Tutorial]] explains how to check BaseX can be checked out BaseX and its sub projects from GitHub (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 subdirectories:# {{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]], please have a look at our [[GIT|GIT TutorialWebDAV]]) # {{Code|basex-examples}} includes some examples code for BaseX# {{Code|basex-tests}} contains 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., <code>org.basex.BaseXGUI</code> for the graphical user interface) # Launch the project via ''Run''
The following packages are available:# [https://github.com/BaseXdb/basex basex] is the main project# [https://github.com/BaseXdb/basex-api basex-api] contains the BaseX APIs (REST, WebDAV, XQJ, XMLDB, and bindings in other languages) # [https://github.com/BaseXdb/basex-examples basex-examples] demonstrates some use cases for BaseX# [https://github.com/BaseXdb/basex-tests basex-tests] contains several coorectness and stress tests==Alternative==
==Start==#Press ''Run'' → ''Run&#8230;''#Create a new "Java Application" launch configuration #Select "basex" You may as "Project" #Choose a "Main class" (e.g.well use the standalone version of [[Maven]] to compile and run the project, <code>orguse other IDEs such as [https://www.basexjetbrains.BaseXGUI<com/code> for the graphical user interface) #Launch the project via ''Run''idea/ IntelliJ IDEA].
[[Category:Developer]]
Bureaucrats, editor, reviewer, Administrators
13,551

edits

Navigation menu