You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@baremaps.apache.org by jo...@apache.org on 2022/12/26 18:13:47 UTC
[incubator-baremaps-site] 01/01: adding maven instructions - linux
This is an automated email from the ASF dual-hosted git repository.
joshfischer pushed a commit to branch joshfischer/add-maven-instructions
in repository https://gitbox.apache.org/repos/asf/incubator-baremaps-site.git
commit 66f825068868b76e3e9ea0d1f0bdea3224415969
Author: Josh Fischer <jo...@joshfischer.io>
AuthorDate: Mon Dec 26 12:13:26 2022 -0600
adding maven instructions - linux
---
Gemfile.lock | 3 ++
developer-manual/how-to-build-with-maven/index.md | 50 ++++++++++++++++++++++-
2 files changed, 52 insertions(+), 1 deletion(-)
diff --git a/Gemfile.lock b/Gemfile.lock
index a7dd89e..afad47c 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -211,6 +211,8 @@ GEM
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.16.3)
+ nokogiri (1.13.9-aarch64-linux)
+ racc (~> 1.4)
nokogiri (1.13.9-x86_64-darwin)
racc (~> 1.4)
nokogiri (1.13.9-x86_64-linux)
@@ -254,6 +256,7 @@ GEM
zeitwerk (2.6.6)
PLATFORMS
+ aarch64-linux
x86_64-darwin-21
x86_64-linux
diff --git a/developer-manual/how-to-build-with-maven/index.md b/developer-manual/how-to-build-with-maven/index.md
index b0bc0a4..0600b98 100644
--- a/developer-manual/how-to-build-with-maven/index.md
+++ b/developer-manual/how-to-build-with-maven/index.md
@@ -6,4 +6,52 @@ permalink: /developer-manual/how-to-build-with-maven/
# How to build with Maven
-TODO
\ No newline at end of file
+This guide describes the basics of compiling Baremaps from source. In order to run Apache Baremaps, you first need to install Java 17 or a later version.
+[SDKMAN](https://sdkman.io/){:target="_blank"} provides a convenient Command Line Interface (CLI) to install and upgrade Java. We also suggest you use the most recent version of Maven
+to compile [(at least 3.x.x)](https://maven.apache.org/download.cgi){:target="_blank"}.
+
+### Linux or OSX
+
+To start you can run the command `mvn clean package` from the root folder of the Baremaps project. Upon successful
+compilation you should see something similar to the following output in your terminal.
+```
+[INFO] Building zip: /path-to-project/baremaps/baremaps-cli/target/baremaps.zip
+[INFO] ------------------------------------------------------------------------
+[INFO] Reactor Summary for baremaps 0.7.1-SNAPSHOT:
+[INFO]
+[INFO] baremaps ........................................... SUCCESS [ 4.172 s]
+[INFO] baremaps-core ...................................... SUCCESS [ 59.018 s]
+[INFO] baremaps-benchmark ................................. SUCCESS [ 1.775 s]
+[INFO] baremaps-ogcapi .................................... SUCCESS [ 9.796 s]
+[INFO] baremaps-server .................................... SUCCESS [ 0.787 s]
+[INFO] baremaps-cli ....................................... SUCCESS [ 20.687 s]
+[INFO] ------------------------------------------------------------------------
+```
+
+It is important to note the first line in the output above that notes where the location of the `baremaps.zip` file resides.
+Referencing the location of the `baremaps.zip` file, you can run the following to unzip
+and place Baremaps into your `PATH`
+```
+$ unzip /path-to-project/baremaps/baremaps-cli/target/baremaps.zip
+$ export PATH=$PATH:`pwd`/baremaps/bin
+```
+
+Executing the `baremaps` command should now result in an output similar to the following:
+
+```
+Usage: baremaps [COMMAND]
+A toolkit for producing vector tiles.
+Commands:
+ import Import OpenStreetMap data in the Postgresql database.
+ update Update OpenStreetMap data in the Postgresql database.
+ export Export vector tiles from the Postgresql database.
+ serve Serve vector tiles from the the Postgresql database.
+```
+
+From here, head into [Installing PostGIS](/getting-started/installing-postgis/) if you plan to work with vector tiles.
+
+If you want to work on [Geocoding](/examples/geocoding/) or
+[IP to location](/examples/ip-to-location/), head directly into the related examples.
+
+### Windows TODO...
+