Skip to content

Commit f841900

Browse files
committed
Update README setup steps and add just init target
Add a convenient `init` target to the justfile that chains install, build-assets, build-templates and fixtures for first-time setup. Update README to reflect actual available justfile targets.
1 parent 5af8d58 commit f841900

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ the Arch Linux package statistics website.
66
- [just](https://github.com/casey/just)
77

88
# Setup
9-
1. Run `just install` to install dependencies
10-
2. Run `just init` to perform the initial setup & start the application locally
11-
3. Use `just start` and `just stop` to start and stop the app.
12-
4. Run `just` for a full list of available commands
9+
1. Run `just init` to install dependencies, build and generate fixtures
10+
2. Run `just run` to start the application locally
11+
3. Run `just` for a full list of available commands
1312

1413
# Contributions
1514
For contributing you'll probably want to test your changes at least once

justfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ export ENVIRONMENT := 'development'
1010
default:
1111
just --list
1212

13+
# first-time setup: install dependencies, build and generate fixtures
14+
init: install build-assets build-templates fixtures
15+
1316
# install dependencies and test data
1417
install:
1518
curl -sf 'https://raw.githubusercontent.com/maxmind/MaxMind-DB/main/test-data/GeoIP2-Country-Test.mmdb' -o '{{ GEOIP_DATABASE }}'

0 commit comments

Comments
 (0)