Changes

Jump to navigation Jump to search
198 bytes added ,  13:38, 2 July 2020
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 Eclipse environment (other IDEs like IntelliJ IDEA can be used as well). The [httphttps://www.eclipse.org /downloads/ EclipseIDE for Java Developers] environmentincludes the EGit plugin (for [[Git]]) and the m2e plugin (for [[Maven]]).  Other IDEs Eclipse plugins we use are used as well in our community, but are not supported by our team.: {| class="wikitable" |- valign="top"! Name! Description! Update URL! Eclipse Marketplace|-* The | [http://wwweclipse-cs.sourceforge.net eclipse-cs]| Enforces Checkstyle coding standards.org| <code><nowiki>http:/egit/ EGit] plugin can be used to check out the latest sources from our repository within Eclipseeclipse-cs.sf.net/update/</nowiki></code>* For additional comfort and to work with packages other than the main project, the | [httphttps://m2eclipsemarketplace.sonatypeeclipse.org m2eclipse/marketplace-client-intro?mpc_install=150 install] plugin is required, which adds |-| [[Mavenhttps://spotbugs.github.io/ SpotBugs]] support to Eclipse| Analyze project at byte code level| <code><nowiki>https://spotbugs.github.io/eclipse/</nowiki></code>* Additional coding guidelines are defined via Checkstyle and can be integrated with the | [httphttps://marketplace.eclipse.org/marketplace-csclient-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-csclient-intro?mpc_install=661 install] plugin.|}
==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), please have a look at our [[GIT|GIT Tutorial]/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 packages are availablesub-directories:# [https://github.com/BaseXdb/{{Code|basex basex] -core}} is the main project# [https://github.com/BaseXdb/{{Code|basex-api basex-api] }} contains the BaseX APIs (RESTXML:DB, WebDAV, XQJ, XMLDB, and bindings in other languages) and HTTP Services ([[REST]], [[RESTXQ]], [[WebDAV]]) # [https://github.com/BaseXdb/{{Code|basex-examples basex-}} includes some examples] demonstrates some use cases code for BaseX# [https://github.com/BaseXdb/basex-tests {{Code|basex-tests] }} contains several coorectness unit and stress tests
==Start==#Press If the "Problems" View contains errors or warnings, you may need to switch to Java 7 (''Windows'' → ''RunPreferences'' → ''Run&#8230;Installed JREs''#Create a new "Java Application" launch configuration #Select "basex" as "Project" #Choose a "Main class" (e.g).With the Maven plugin from Eclipse, <code>org.basexit sometimes requires several attempts to get all dependencies updated.BaseXGUI</code> for the graphical user interface) #Launch This loop can be avoided if the project sources are precompiled via ''Run''[[Maven]] on command-line.
==Using MavenStart in Eclipse== # Press ''Run'' → ''Run&#8230;''# Create a new "Java Application" launch configuration # Select "basex" as "Project" If the standalone version of [http://maven# Choose a "Main class" (e.apacheg.org Maven] is installed,you can run<code> mvn compile org.basex.BaseXGUI</code>in for the graphical user interface) # Launch the project directory to compile BaseX.via ''Run'' ==Alternative==
Should you wish You may as well use the standalone version of [[Maven]] to create compile and run the project, use other IDEs such as [https:/ package your own jars you can do so by running <code>mvn package</code>www.By adding the flag <code>-DskipTests=true</code> you can skip running the JUnit-testsjetbrains. Type in<code> java -cp targetcom/classesidea/orgIntelliJ IDEA].basex.BaseX </code>to run BaseX. You can launch the following classes, which are all placed in the<code>org.basex</code> main package:
;[[Startup_Options#BaseX_Standalone|BaseX]]
: standalone (embedded) mode
;[[Startup_Options#BaseX_Server|BaseXServer]]
: server instance, waiting for requests
;[[Startup_Options#BaseX_Client|BaseXClient]]
: client instance, interacting with the server
;[[Startup_Options#BaseX_GUI|BaseXGUI]]
:graphical user interface
Moreover, try <code>-h</code> to have a look at the available command-line options.
For example, you can evaluate XQuery expressions or process database commands without
entering the console.
[[Category:Developer]]
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu