Live Demo: http://chess-variant-20191210113159-hostingbucket-develop.s3-website-us-east-1.amazonaws.com/

How to install and demo on your computer

1. Open an issue or send an email to xzhu000@citymail.cuny.edu stating you would like to receive an aws-exports.js file to run the project locally. The file should be placed under the src folder.
2. Clone the project on your computer
3. cd to the directory with the project files.
4. npm install
5. npm start

If you want to run this project locally on your machine, npm install (or sudo npm install) may fail to execute the post-install script in package.json which copies our own version of chess.js into the chess.js library folder in node_modules (using the cp command). (For the purposes of putting all our code in one repo, we did not put our chess.js module in a separate GitHub repo, and this was the solution we chose).

After npm install, check whether you get a warning like

Then it is imperative that you copy chess.js to node_modules/chess.js yourself. Try sudo npm run postinstall on Linux. If that doesn't work for some reason, you can try to npm install again with the --unsafe-perm flag (npm install --unsafe-perm). Alternatively (e.g., if you're on Windows and there is no cp command), you can manually copy chess.js to the node_modules/chess.js folder.

If you encounter a puppeteer installation error after npm install, see puppeteer/puppeteer#2173 (comment).

How to test

1. npm test (npm test -- <file_path> if you want to run a particular test file)
2. npm test -- --coverage if you want to see the test coverage.

The tests are located in src/test.