Skip to content

Commit

Permalink
Merge pull request #397 from govdirectory/justfile
Browse files Browse the repository at this point in the history
add a Justfile
  • Loading branch information
Ainali authored Jun 22, 2024
2 parents ebcbc07 + ef81fce commit 263ac29
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ 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 [Just](https://github.com/casey/just), if you do not use just you can still look in the `justfile` for hints.
>
### Prerequisites

- [Git](https://git-scm.com/)
Expand Down
1 change: 1 addition & 0 deletions jargon.txt
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ switzerland
synergize
Temaki
th
timeit
timor
TinyPNG
tl
Expand Down
23 changes: 23 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -0,0 +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 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 263ac29

Please sign in to comment.