git.r.bdr.sh - rbdr/forum/blob - README.md

   1 # Forum
   2
   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
  11 For local development serve the page by running `npm run dev` from the
  12 root of the project.
  13
  14 This project depends on the [forum server][forum-server], so make sure
  15 that's running before starting.
  16
  17 ## Testing
  18
  19 You can run tests with `npm test`. The tests use `testing-library`, `pact`,
  20 and `jest`.
  21
  22 Here's some short guidelines:
  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
  28
  29 [node]: https://nodejs.org/en/
  30 [forum-server]: https://gitlab.com/rbdr/forum-server