Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
* 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.* The [http://m2eclipse.sonatype.org m2eclipse] EGit plugin is required to work with packages other than the main project; it 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] plugin.* Other Eclipse plugins we frequently use are [http://findbugs.sourceforge.net/ FindBugsMaven] to analyze Java byte code, and [http://www.eclipse.org/eclipse/platform-core/downloads.php Core Tools] to find unreferenced members).
You may as well Other Eclipse plugins we use the standalone version of 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>| [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]|}
To get some help on Our [[Git|Git Tutorial]] explains how to check BaseX can be checked out BaseX and its sub projects from the [https://github.com/BaseXdb /basex GitHub RepositoriesRepository], and embedded in Eclipse with EGit. The article also demonstrates how to optionally use BaseX git can be used on command -line. The basex repository contains the following sub-directories:# {{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
The following repositories are available:# [https://github.com/BaseXdb/basex basex] is If the main project# [https://github.com/BaseXdb/basex-api basex-api] "Problems" View contains the BaseX APIs errors or warnings, you may need to switch to Java 7 (XQJ, XMLDB, and bindings in other languages''Windows'' → ''Preferences'' → ''Installed JREs'') and HTTP Services ([[REST]]. 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 precompiled via [[RESTXQ]], [[WebDAVMaven]]) # [https://github.com/BaseXdb/basexon command-examples basex-examples] includes some examples code for BaseX# [https://githubline.com/BaseXdb/basex-tests basex-tests] contains several correctness and stress tests
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==
==Check Out==
==Start in Eclipse==
# Choose a "Main class" (e.g., <code>org.basex.BaseXGUI</code> for the graphical user interface)
# Launch the project via ''Run''
==Alternative==
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]]
