Arrr.io

Arrr.io is a face-paced multiplayer pirate game built on the example.io skeleton with Node.js, socket.io, and HTML5 Canvas.

Documentation

Documentation for the server and client are in their respective directories src/server and src/client.

Production

If you just want to start the server, make sure you have Node (>14.2.0) and NPM installed. Then run:

$ npm install
$ npm run build:prod
$ npm run start:prod

and you'll have a server running on localhost:3000.

Development

To get started, make sure you have Node (>14.2.0) and NPM installed. Then run:

$ npm install
$ npm run build:dev
$ npm run start:dev

to start a server on localhost:3000.

Testing

To run all the jest tests:

$ npm run test

Tests for any module's functionality should be added in the same directory and named filename.test.js.