Skip to content

Commit

Permalink
Add info for Viewer Docker container
Browse files Browse the repository at this point in the history
  • Loading branch information
avillar committed Feb 2, 2024
1 parent d9028b1 commit 72638c2
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/workflows/process-bblocks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ permissions:

jobs:
validate-and-process:
name: Validate and process
uses: opengeospatial/bblocks-postprocess/.github/workflows/validate-and-process.yml@master
# with:
# sparql_username: sparql
Expand Down
19 changes: 18 additions & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ The outputs can be generated locally by running the following:

```shell
# Process building blocks
docker run --pull=always --rm --workdir /workspace -v $(pwd):/workspace \
docker run --pull=always --rm --workdir /workspace -v "$(pwd):/workspace" \
ghcr.io/opengeospatial/bblocks-postprocess --clean true
# Optional - build Slate docs
docker run --pull=always --rm \
Expand All @@ -265,9 +265,26 @@ docker run --pull=always --rm \
**Notes**:

* Docker must be installed locally for the above commands to run
* The syntax for `-v "$(pwd):/workspace"` may vary depending on your operating system
* Output files will be created under `build-local` (not tracked by git by default)
* The value for `--base-url` will be used to generate the public URLs (schemas, documentation, etc.)

#### Building Blocks Viewer

You can also preview what the output will look like inside the Building Blocks Viewer application:

```shell
docker run --rm --pull=always -v "$(pwd):/register" -p 9090:9090 ghcr.io/ogcincubator/bblocks-viewer
```

**Notes**:

* Make sure to [compile the register](#output-testing) before running the viewer (or delete `build-local`
altogether to view the current build inside `build`).
* Docker must be installed locally for the above commands to run
* The syntax for `-v "$(pwd):/register"` may vary depending on your operating system
* `-p 9090:9090` will publish the Viewer on port 9090 on your machine

## Tools

The following tools are useful for getting each component working during development:
Expand Down

0 comments on commit 72638c2

Please sign in to comment.