X-Git-Url: https://git.r.bdr.sh/rbdr/forum/blobdiff_plain/1be5af9305937d4def3bf190b72e4e5450e989cb..852ee620f0a2f6a83cf83eba860ca951b66bb7e2:/README.md diff --git a/README.md b/README.md index a07c14e..3e0f099 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,23 @@ This project uses [node][node] for most of its development processes. Once you have node installed according to the instructions there, run `npm install` from the root of the project. -For local development serve the page by running `npm watch` from the +For local development serve the page by running `npm run dev` from the root of the project. -## Installing git hooks +This project depends on the [forum server][forum-server], so make sure +that's running before starting. -This repo contains a pre-commit git hook so indent will run before every -commit. Run `npm run setup-hooks` to install it. +## Testing + +You can run tests with `npm test`. The tests use `testing-library`, `pact`, +and `jest`. + +Here's some short guidelines: + +- Every component that receives props or changes state should be tested. +- Test expected outcomes, not implementation details. +- Avoid mocking unless it's an external call +- Stores that interact with the API should be tested using pact [node]: https://nodejs.org/en/ +[forum-server]: https://gitlab.com/rbdr/forum-server