]> git.r.bdr.sh - rbdr/forum/blame - README.md
Update dependencies
[rbdr/forum] / README.md
CommitLineData
5a2bb071
RBR
1# Forum
2
1be5af93
BB
3A forum for the year 3000.
4
5## What you will need to get started
6
7This project uses [node][node] for most of its development processes.
8Once you have node installed according to the instructions there, run
9`npm install` from the root of the project.
10
f088a659 11For local development serve the page by running `npm run dev` from the
1be5af93
BB
12root of the project.
13
f088a659
RBR
14This project depends on the [forum server][forum-server], so make sure
15that's running before starting.
38416066 16
47b0bfe4
RBR
17## Testing
18
19You can run tests with `npm test`. The tests use `testing-library` and
20`jest`.
21
22Here's some short guidelines:
23 - Every component that receives props or changes state should be tested.
24 - Test expected outcomes, not implementation details.
25 - Avoid mocking unless it's an external call
26
1be5af93 27[node]: https://nodejs.org/en/
f088a659 28[forum-server]: https://gitlab.com/rbdr/forum-server