Skip to content

Commit 4db0dc6

Browse files
committed
feat(docs): update README to match Makefile
1 parent ae550db commit 4db0dc6

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@
1313

1414
## Development
1515

16+
Before starting development, install dependencies with:
17+
18+
```shell
19+
make deps
20+
```
21+
22+
This will install both the Clojure and the NPM dependencies required.
23+
1624
### Run Clojure REPL
1725

1826
```shell
@@ -24,9 +32,17 @@ This will start a Clojure REPL that includes shadow-cljs (which we use to build
2432
From that namespace:
2533

2634
- The app server can be (re)started with `(go)`. This will also start the `shadow-cljs` process for building the frontend and watching for changes.
27-
- We can swtich to the ClojureScript REPL with `(cljs-repl)`
35+
- We can switch to the ClojureScript REPL with `(cljs-repl)`
2836
- Use `:cljs/quit` to return to the Clojure REPL
2937

38+
### Build CSS
39+
40+
```shell
41+
make css-watch
42+
```
43+
44+
This will start PostCSS to watch for changes in `resources/styles/*.css`.
45+
3046
### Unit tests
3147

3248
Run unit tests of the service using the kaocha test runner
@@ -52,16 +68,16 @@ Also edit config/deploy.yml to ensure it matches your setup. See the [Kamal docs
5268
It’s possible to build an uberjar and run it locally to test before deploying:
5369

5470
```shell
55-
make dist
56-
java -jar target/parts-standalone.jar
71+
make dist && make run-dist
5772
```
5873

5974
### Deploy
6075

6176
A deployment can be started via:
6277

6378
```shell
64-
make deploy
79+
# Always run tests before deploying
80+
make test && make deploy
6581
```
6682

6783
## License

0 commit comments

Comments
 (0)