/high-performance-teams-game

Primary LanguageTypeScript

High-Performance Teams Game

deploy codecov published

Getting Started

System Requirements

  • git v2.13 or greater
  • NodeJS v14 or greater
  • npm v7 or greater

All of these must be available in your PATH. To verify things are set up properly, you can run this:

git --version
node --version
npm --version

If you have trouble with any of these, learn more about the PATH environment variable and how to fix it here for windows or mac/linux.

Set up the project locally

git clone git@github.com:Xiphe/high-performance-teams-game.git
cd high-performance-teams-game
npm install

Recommended development environment

It's recommended to use Visual Studio Code and have these extensions installed:

  • editorconfig.editorconfig
  • dbaeumer.vscode-eslint
  • esbenp.prettier-vscode
  • stylelint.vscode-stylelint
  • ms-vsliveshare.vsliveshare (for pairing)

Starting a development-server

In the project directory, run:

npm start

This should directly open http://localhost:3000 in your browser.

Starting unit tests

In the project directory, run:

npm test

Simulate games

In the project directory, run:

# Simulate 300 runs
npm run simulate 300

This will open a jest session in the terminal.

Good resources to learn about everything used here: