Difference between revisions of "Maven"
Jump to navigation
Jump to search
Line 10: | Line 10: | ||
* <code>mvn install</code>: the JAR archive is installed to the local repository, and made available to other Maven projects. This is particularly useful if you are compiling a beta version of BaseX, for which no archives exist in the repositories. | * <code>mvn install</code>: the JAR archive is installed to the local repository, and made available to other Maven projects. This is particularly useful if you are compiling a beta version of BaseX, for which no archives exist in the repositories. | ||
− | By adding the flag <code>-DskipTests=true</code> you can skip running the JUnit tests and speed up the packaging procedure. You may as well use [[ | + | By adding the flag <code>-DskipTests=true</code> you can skip running the JUnit tests and speed up the packaging procedure. You may as well use [[Eclipse|Eclipse and m2eclipse]] to compile the BaseX sources. |
==Artifacts== | ==Artifacts== |
Revision as of 12:52, 11 December 2012
This page is part of the Developer Section. It demonstrates how Maven is used to compile and run BaseX, and embed it into other projects.
Using Maven
If you have cloned our repositories and installed Maven on your machine, you can run the following commands from all local repository directories:
mvn compile
: the BaseX source files are compiled. To launch the project, type injava -cp target/classes org.basex.BaseX
, or have a look at our Start Scripts.mvn package
: JAR archives are created in thetarget
class directory.mvn install
: the JAR archive is installed to the local repository, and made available to other Maven projects. This is particularly useful if you are compiling a beta version of BaseX, for which no archives exist in the repositories.
By adding the flag -DskipTests=true
you can skip running the JUnit tests and speed up the packaging procedure. You may as well use Eclipse and m2eclipse to compile the BaseX sources.
Artifacts
You can easily embed BaseX into your own Maven projects by adding the following XML snippets to your pom.xml
file:
<repositories> <repository> <id>basex</id> <name>BaseX Maven Repository</name> <url>http://files.basex.org/maven</url> </repository> </repositories>
BaseX Main Package
<dependency> <groupId>org.basex</groupId> <artifactId>basex</artifactId> <version>7.3</version> </dependency>
APIs and Services
...including APIs and the REST, RESTXQ and WebDAV services:
<dependency> <groupId>org.basex</groupId> <artifactId>basex-api</artifactId> <version>7.3</version> </dependency>
XQJ API
The XQJ API is hosted at http://xqj.net:
<repository> <id>xqj</id> <name>XQJ Maven Repository</name> <url>http://xqj.net/maven</url> </repository> ... <dependency> <groupId>net.xqj</groupId> <artifactId>basex-xqj</artifactId> <version>1.2.0</version> </dependency> <dependency> <groupId>com.xqj2</groupId> <artifactId>xqj2</artifactId> <version>0.1.0</version> </dependency> <dependency> <groupId>javax.xml.xquery</groupId> <artifactId>xqj-api</artifactId> <version>1.0</version> </dependency>