Prerequisite: You will need to have yarn installed.
git clone https://github.com/simonbw/commander-periscope
cd commander-periscope
yarn
yarn dev
We use storybook to test individual pages and components. To start the storybook server run:
yarn storybook
We also publish the storybook for the code on master to the web. You can view that here.
There are a number of open issues. Feel free to comment on one you're interested in and start working on it. When you think you're finished and the tests are passing, submit a pull request.
If you're working on react components, you'll probably want to use storybook so you don't have to spin up the full server and try to the state you want to test. Look in stories for some examples.
If you're working on server code, you will likely find integration testing to be helpful, since testing the game manually requires spinning up 8 clients. We use puppeteer to spin up multiple clients in parallel to play through a game.