Changes

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]]. ==InstallationPrerequisites==

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: {| 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>| [https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=Prerequisites150 install]|-| [https://spotbugs.github.io/ SpotBugs]| Analyze project at 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==

* Our [[Git|Git Tutorial]] explains how BaseX is being developed with can be checked out from the [httphttps:www//github.eclipsecom/BaseXdb/basex GitHub Repository] and embedded in Eclipse with EGit.org Eclipse] environmentThe article also demonstrates how git can be used on command-line. Some styleguidelines are integrated in The basex repository contains the sources of BaseX; they are being embedded as soon as you open following subdirectories:# {{Code|basex-core}} is the main project.* The [http# {{Code|basex-api}} contains the BaseX APIs (XML://subclipse.tigris.org Subclipse Plugin] is needed to check out the latest sources from DB, bindings in other languages) and HTTP Services ([[Subversion_Repository|our repositoryREST]].* To work with packages other than the main project, the [http://m2eclipse.sonatype.org m2eclipse[RESTXQ]] plugin is required to add , [[MavenWebDAV]] support to Eclipse.) # {{Code|basex-examples}} includes some examples code for BaseX* Additional coding guidelines are defined via Checkstyle # {{Code|basex-tests}} contains several unit and can be integrated with stress tests If the [http://eclipse-cs.sourceforge.net eclipse-cs] plugin"Problems" View contains errors or warnings, you may need to switch to Java 11 (''Windows'' → ''Preferences'' → ''Java'' → ''Installed JREs'').

===Check Out=Start in Eclipse== To checkout BaseX, do the following: # ''File'' → ''Import''# ''SVN'' → ''Check out Projects from SVN''# Enter [https://svn.uni-konstanz.de/dbis/basex https://svn.uni-konstanz.de/dbis/basex/trunk] as repository# Choose the project you like:<br/> ## [https://svn.uni-konstanz.de/dbis/basex/trunk/basex basex] is the main project## [https://svn.uni-konstanz.de/dbis/basex/trunk/api api] contains the BaseX APIs (JAX-RX, XQJ, XMLDB, and bindings in other languages) ## [https://svn.uni-konstanz.de/dbis/basex/trunk/examples examples] demonstrates some use cases for BaseX ## [https://svn.uni-konstanz.de/dbis/basex/trunk/jax-rx jax-rx] represents the JAX-RX Interface# Click ''Finish''

===Run BaseX with Eclipse=== #Press ''Run'' → ''Run&#8230;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''

==Alternative=Compile &#38; Run BaseX=== <p>If the standalone version of [http://maven.apache.org Maven] is installed, you can run<code> mvn compile </code>in the project directory to compile BaseX. Should you wish to create / package your own jars you can do so by running <code>mvn package</code>. By adding the flag <code>-DskipTests=true</code> you can skip running the JUnit-tests.</p> <p>Type in<code> java -cp target/classes/org.basex.BaseX </code>to run BaseX.</p> <p>You can launch the following classes, which are all placed in the <code>org.basex</code> main package:</p>

;You may as well use the standalone version of [[Console|BaseXMaven]]: console mode;[[Server Tutorial|BaseXServer]]: server instanceto compile and run the project, waiting for requests;[use other IDEs such as [Server Tutorial|BaseXClient]]https: console mode, interacting with the server;[[GUI Tutorial|BaseXGUI]]:graphical user interface <p>Moreover, try <code>-h</code> to have a look at the available command-line options/www. For example, you can evaluate XQuery expressions or process database commands without entering the consolejetbrains.<com/p>idea/ IntelliJ IDEA].