NChess Online is a basic chess app that allows people to play chess against their friends.

The app should work with all environments that have installed. If you are having issues running commands try upgrade your node version (should work with node >14)

You can run a local node server using this command. The app will start at localhost:8080

npm start # run local web server

Some scripts/npm commands will not work if you have not set up the python virtual environment

source ./backend/venv/bin/activate (venv) npm run clear_db // OR ./scripts/clear_local_database.sh

docker build . -t chess-image # Builds docker image that runs chess app server docker run -d -p 8080:8080 chess-image # Runs docker image in background on port 8080

git push heroku master

npm run test

The end to end test run using cypress. Make sure the app is running locally before starting tests and that the python virtual environment is activated

// Prerequisites
source ./backend/venv/bin/activate
npm run start
npm run start:backend

npm run e2e
npx cypress open

The tests rely on PGN files in the LAN format. These files can be found in the fixtures folder of the cypress tests.

Most PGN formats are in the SAN format hence must be converted. You can use the pgn-extract to convert SAN files to LAN files.

pgn-extract.exe -Wuci < file.pgn # WINDOWS: SAN -> LAN