Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.29 KB

BUILD.md

File metadata and controls

32 lines (22 loc) · 1.29 KB

Building Elemental from Source Code

Elemental itself is written in Java 21. The build system is Apache Maven. If you're not familiar with Git, we recommend this excellent online interactive tutorial.

To build Elemental:

  • Checkout the Git Repository
  • Execute a Maven to compile Elemental
$ git clone https://github.com/evolvedbinary/elemental.git
$ cd elemental
$ git checkout gold
$ mvn -DskipTests package

From here, you now have a compiled version of Elemental in the exist-distribution/target folder that you may use just as you would an installed version of Elemental. An installer is also build and present in exist-installer/target for easy installation elsewhere.

Useful build switches:

  • -Ddocker=true : builds the docker image
  • -DskipTests : skips running tests
  • -Ddependency-check.skip=true : skips validating dependencies

Further build options can be found at: eXist-db Build Documentation.

NOTE: In the above example, we switched the current (checked-out) branch from main to gold.

  • main is the current (and stable) work-in-progress (the next release)
  • gold is the last release The choice of which to use is up to you.