diff options
| author | Ben Woodward <ben@bdw.to> | 2021-07-15 08:49:13 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-15 08:49:13 -0700 |
| commit | 210433598a3072ed0ade022a580ac4522e491c01 (patch) | |
| tree | 31f4022dbd022c050bc1201076e79cc2732e49b7 /README.md | |
| parent | 0d71702b4811cf29dcc5b4627236b9b747d06c07 (diff) | |
Local development setup (#47)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 19 insertions, 2 deletions
| @@ -16,8 +16,25 @@ Run the official Docker image on http://localhost:8080 | |||
| 16 | make run | 16 | make run |
| 17 | ``` | 17 | ``` |
| 18 | 18 | ||
| 19 | Run the live-reload server on http://localhost:3000 | 19 | ## Development |
| 20 | |||
| 21 | 1. Make sure you have `yarn` installed | ||
| 22 | 2. Run the live-reload server on http://localhost:3000 | ||
| 23 | ``` | ||
| 24 | make dev | ||
| 25 | ``` | ||
| 26 | |||
| 27 | This project uses [Prettier](https://prettier.io/) formatting and all pull requests must pass | ||
| 28 | the automated lint checks prior to merging. | ||
| 29 | |||
| 30 | Run the link check with: | ||
| 31 | |||
| 32 | ``` | ||
| 33 | npx prettier --check . '!**/*.min.{css,js}' | ||
| 34 | ``` | ||
| 35 | |||
| 36 | Rewrite the files to resolve any style issues with: | ||
| 20 | 37 | ||
| 21 | ``` | 38 | ``` |
| 22 | make dev | 39 | npx prettier --write . '!**/*.min.{css,js}' |
| 23 | ``` | 40 | ``` |
