Contributing

If you're looking for an easy way to contribute, check out the TODO list.

If you want to make a change that alters the gameplay, open an issue first so we can talk it over.

To run locally

Install DynamoDB. Extract it somewhere like ~/dynamodb_local_latest

Run DynamoDB locally in some terminal tab and run the schema-creation script:

java -Djava.library.path=~/dynamodb_local_latest/DynamoDBLocal_lib -jar ~/dynamodb_local_latest/DynamoDBLocal.jar -sharedDb
npm run create-schema

Clone the repo, install, run:

git clone git@github.com:TehShrike/spyfallx.git
cd spyfallx
npm install
npm run dev

Then open http://localhost:8888/ in your browser.

To run the tests

There aren't a lot of tests, but hey, there are some.

npm install
npm test

License

WTFPL