README.md

Run Boris Run

Netlify Status:

Travis Status:

Play the game Here

What is Run Boris, Run?

Covid-game, a.k.a 'Run Boris, Run!', is a game developed to pass the time in quarantine whilst also practising your social distancing skills (virtually of course!).

Instructions

Welcome to "our game".

Covid has struck the world. You must now adapt to survive.

Mrs. Morris is in desperate need of milk, but she can not leave her home as she is old and at risk of infection. You are her only hope of having a cuppa.

Are you up for the challenge?

You must not come within 2 meters of anyone or you will be at risk yourself.

If you stay too close for too long you will get sick and be placed in quarantine.

Playing the game

[PLACEHOLDER]

Team Members

• Edmond Bullaj
• Lizzie Turney
• Jo Collier
• Gareth Woodman
• Colin Muir
• Hibo Abdilaahi

Technologies

Purpose	Technology
Front end framework	React,
Languages	Javascript, HTML5
CI/CD	Travis
Hosting	Netflify
Styling	CSS
Front end testing framework	Jest
Code Coverage	Jest

Installing Covid-Game onto your local machine

To get started using Covid Game on your local machine, please follow the instructions below:

Install Node.js

Skip this step if you already have Node.js installed

1. Install Node Version Manager (NVM)

   brew install nvm
   

   Then follow the instructions to update your ~/.bash_profile.
2. Open a new terminal
3. Install the latest long term support (LTS) version of Node.js, currently 12.14.1.

   nvm install 12.14.1
   

Getting set up

Once you have installed Node:

1. Clone this repository to your local machine
2. Install Node.js dependencies using the command:

   npm install
   

Using Covid-Game!

1. To start, navigate to the Covid-Game root directory and enter the command:

   npm run start
   

For optimal results, use Google Chrome.

Testing

To run tests

• Run all tests

  npm run test
  

This will show you test results and coverage for the individual files and overall project.