Skip to content

Commit

Permalink
added inline descriptions to justfile
Browse files Browse the repository at this point in the history
  • Loading branch information
Abbe98 committed Jun 5, 2024
1 parent cd320af commit 555a6ed
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ Govdirectory is a static site meaning that it already has all of its pages gener
Because each initial build of Snowman issues thousands (yes thousands) of SPARQL queries one should never make an **initial** build against `query.wikidata.org` but rather against a local Wikidata Query Service (WDQS) instance. However, because setting up a WDQS instance is nontrivial we provide a copy of a [Snowman build cache directory](https://github.com/govdirectory/website-cache). If in use, this will ensure Snowman only queries Wikidata when a query is updated.

> [!TIP]
> Some of the most common development commands are available through our [Justfile](https://github.com/casey/just)
> Some of the most common development commands are available through [Just](https://github.com/casey/just), if you do not use just you can still look in the `justfile` for hints.
>
### Prerequisites

Expand Down
7 changes: 6 additions & 1 deletion justfile
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
@_default:
just --list

# build the full project
build:
snowman build --timeit

# build the full project and once done, start the development server
build-serve:
snowman build --timeit && snowman server

# only update the static files of the last build
build-static:
snowman build --static

clear-query-cache:
# clear all queries from the cache
clear-cache:
snowman cache --invalidate

# setup a new cache from our remote cache repository
bootstrap-cache:
git clone https://github.com/govdirectory/website-cache .snowman

0 comments on commit 555a6ed

Please sign in to comment.