Changes

Jump to navigation Jump to search
95 bytes removed ,  12:51, 29 February 2016
Removed the eclipse marketplace image
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] includes the EGit plugin (for [[Git]] environment) 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|-| [http://eclipse-cs.sourceforge.net eclipse-cs]| Enforces Checkstyle coding standards.| <code><nowiki>http://eclipse-cs.sf.net/update/</nowiki></code>* The | [http://wwwmarketplace.eclipse.org/egitmarketplace-client-intro?mpc_install=150 install]|-| [http:/ EGit/findbugs.sourceforge.net FindBugs] plugin is needed to check out the latest sources from our repository within Eclipse| Analyze project at byte code level| <code><nowiki>http://findbugs.cs.umd.edu/eclipse</nowiki></code>* For additional comfort and to work with packages other than the main project, the | [http://m2eclipsemarketplace.sonatypeeclipse.org m2eclipse/marketplace-client-intro?mpc_install=1099 install] plugin is required, which adds |-| [[Mavenhttp://www.ucdetector.org/ UCDetector]] support to Eclipse| Unnecessary code detector| <code><nowiki>http://ucdetector.sourceforge.net/update</nowiki></code>* Additional coding guidelines are defined via Checkstyle and can be integrated with the | [http://marketplace.eclipse.org/marketplace-client-csintro?mpc_install=661 install]|-| [http://www.eclemma.org/ EclEmma]| Code coverage tool.| <code><nowiki>http://update.eclemma.sourceforgeorg/</nowiki></code>| [http://marketplace.net eclipse.org/marketplace-csclient-intro?mpc_install=264 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/basex-api {{Code|basex-api] }} contains the BaseX APIs (JAX-RXXML:DB, 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/jax{{Code|basex-rx jax-rx] tests}} contains the JAX-RX Interfaceseveral unit and stress tests
Older versions of BaseX If the "Problems" View contains errors or warnings, you may need to switch to Java 7 (''Windows'' → ''Preferences'' → ''Installed JREs''). With the Maven plugin from Eclipse, it sometimes requires several attempts to get all dependencies updated. This loop can be avoided if the sources are still available precompiled via our Subversion repository (https://svn.uni[[Maven]] on command-konstanzline.de/dbis/basex):
==Start in Eclipse==# Press ''Run'' → ''Run&#8230;''# Create a new "Java Application" launch configuration # [https://svn.uni-konstanz.de/dbis/Select "basex/trunk/basex basex] is the main project" as "Project" # [https://svnChoose a "Main class" (e.uni-konstanzg.de/dbis/basex/trunk/api api] contains the BaseX APIs (JAX-RX, XQJ, XMLDB, and bindings in other languages) # [https://svn<code>org.uni-konstanzbasex.deBaseXGUI</dbis/basex/trunk/examples examples] demonstrates some use cases code> for BaseX the graphical user interface) # [https://svn.uni-konstanz.de/dbis/basex/trunk/jax-rx jax-rx] contains Launch the JAX-RX Interfaceproject via ''Run''
==StartAlternative==#Press ''Run'' → ''Run&#8230;''#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''
==Using Maven== If You may as well use the standalone version of [[Maven]] to compile and run the project, use other IDEs such as [http://mavenwww.apachejetbrains.org Mavencom/idea IntelliJ IDEA] 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.
Type in<code> java -cp target/classes/org.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 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]]
administrator, editor
1

edit

Navigation menu