aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBen Woodward <ben@bdw.to>2021-07-15 08:49:13 -0700
committerGitHub <noreply@github.com>2021-07-15 08:49:13 -0700
commit210433598a3072ed0ade022a580ac4522e491c01 (patch)
tree31f4022dbd022c050bc1201076e79cc2732e49b7 /README.md
parent0d71702b4811cf29dcc5b4627236b9b747d06c07 (diff)
Local development setup (#47)
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 19 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4d04b4b..5d4fe19 100644
--- a/README.md
+++ b/README.md
@@ -16,8 +16,25 @@ Run the official Docker image on http://localhost:8080
16make run 16make run
17``` 17```
18 18
19Run the live-reload server on http://localhost:3000 19## Development
20
211. Make sure you have `yarn` installed
222. Run the live-reload server on http://localhost:3000
23 ```
24 make dev
25 ```
26
27This project uses [Prettier](https://prettier.io/) formatting and all pull requests must pass
28the automated lint checks prior to merging.
29
30Run the link check with:
31
32```
33npx prettier --check . '!**/*.min.{css,js}'
34```
35
36Rewrite the files to resolve any style issues with:
20 37
21``` 38```
22make dev 39npx prettier --write . '!**/*.min.{css,js}'
23``` 40```