Skip to content

Commit 4af6663

Browse files
committed
docs: update dev instructions
1 parent 658bd15 commit 4af6663

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ None. Please don't use this as a standalone server. This should be used behind a
9292

9393
## Developers
9494

95-
1. Start the database using `docker-compose -f test/db/docker-compose.yml up`
96-
2. Run `npm run dev`
97-
3. Run `npm test` while you work
95+
To start developing, run `npm run dev`. It will set up the database with Docker for you. The server will restart on file change.
96+
97+
To test your changes, run `npm run test`. To review your changes, add the `-u/--updateSnapshot` flag to `jest` on the `test:run` script, run `npm run test`, and then review the git diff of the snapshots. Don't forget to remove the `-u/--updateSnapshot` flag when committing.
9898

9999
## Licence
100100

0 commit comments

Comments
 (0)