Changes

Jump to navigation Jump to search
255 bytes added ,  15:09, 29 July 2022
no edit summary
==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/ Eclipse IDE for Java Developers] includes the EGit] plugin can be used to check out the latest sources from our repository within Eclipse.* The (for [[http://m2eclipse.sonatype.org m2eclipseGit]] ) and the m2e plugin is required to work with packages other than the main project; it adds (for [[Maven]] support to ). Other plugins we use are: {| class="wikitable" |- valign="top"! Name! Description! Update URL! Eclipse.Marketplace|-* Additional coding guidelines are defined via Checkstyle and can be integrated with the | [http://eclipse-cs.sourceforge.net eclipse-cs] plugin| Enforces Checkstyle coding standards.* Other Eclipse plugins we frequently use are [| <code><nowiki>http://findbugseclipse-cs.sourceforgesf.net/ FindBugsupdate/</nowiki></code>| [https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=150 install]|-| [https://spotbugs.github.io/ SpotBugs] to analyze Java | Analyze project at byte code, and level| <code><nowiki>https://spotbugs.github.io/eclipse/</nowiki></code>| [https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=3519199 install]|-| [http://www.eclipseucdetector.org/UCDetector]| Unnecessary code detector| <code><nowiki>http://ucdetector.sourceforge.net/update</nowiki></code>| [https://marketplace.eclipse.org/platformmarketplace-core/downloads.php Core Toolsclient-intro?mpc_install=661 install] to find unreferenced members.|}
==Check Out==
To get some help on Our [[Git|Git Tutorial]] explains how to check BaseX can be checked out BaseX from the [https://github.com/BaseXdb/basex GitHub Repository], and embedded in Eclipse with EGit. The article also demonstrates how to optionally compile BaseX git can be used on command -line, please have a look at our [[Git|Git Tutorial]].
The basex repository contains the following sub-directoriessubdirectories:
# {{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]], [[WebDAV]])
# {{Code|basex-tests}} contains several unit and stress tests
With If the Maven plugin from Eclipse"Problems" View contains errors or warnings, it you may require several attempts need to get all dependencies updated. This loop can be avoided if the sources are precompiled via [[Maven]] on command-lineswitch to Java 11 (''Windows'' → ''Preferences'' → ''Java'' → ''Installed JREs'').
==Start in Eclipse==
 # Press ''Run'' → ''Run&#8230;Run…''
# Create a new "Java Application" launch configuration
# Select "basex" as "Project"
==Alternative==
You may as well use the standalone version of [[Maven]] to compile and run the project, use other IDEs such as [httphttps://www.jetbrains.com/idea / IntelliJ IDEA]. 
[[Category:Developer]]
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu