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