[rbdr/forum] / doc / README.md

forum / [Exports](modules.md)

# Forum

A forum for the year 3000.

## What you will need to get started

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 run dev` from the
root of the project.

This project depends on the [forum server][forum-server], so make sure
that's running before starting.

## 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