A websocket version of The Resistance.
This software uses io.js. Installing io.js is beyond the scope of this readme, but I suggest using nvm.
(This might run fine under the standard Node.js, but I haven't tried.)
- Download the project or check it out with git
- Install the project dependencies:
npm install --production
- Start the server:
npm start
- Navigate to the game from your browser:
http://localhost:3000
Installing the dependencies without the production flag (i.e., npm install
)
will allow you to run the tests and do other development-y things. I suggest
installing CoffeeScript globally (i.e., npm install -g coffee-script
) to
have easy access to the REPL.
The front end assets are also written in CoffeeScript using Angular.js as the framework. All of the front-end assets (CoffeeScript, Sass, views, etc.) are minified with Gulp.
To make development simpler, there are three custom scripts added to npm:
start-dev
: Starts a server withsupervisor
that restarts the server on changesg
: Runs Gulpgw
: Runs Gulp with thewatch
task
You can run these scripts with npm run-script [script]