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

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