quest-for-nothing

A simple jump and run game.
This should run in any recent browser with html5 support.

Install instructions

1. Make sure you have node.js (min 7.10.0) and git installed.
2. Clone this repository with git clone [email protected]:danielHpeters/quest-for-nothing.git or git clone https://github.com/danielHpeters/quest-for-nothing.git.
3. Run npm install command in the root directory of the clone.
4. Run npm install gulp-cli to enable the gulp command globally.
5. Run npm start command to start the server.
6. Open a browser and enter http://localhost:3000 in the search bar to start playing.

Developer instructions

This project uses gulp for build automation (transpiling and minifying JavaScript and code linting.

• gulp default command runs all these tasks.
• gulp 'build:server for converting server side code to JavaScript and then copying it to the dist folder.
• gulp 'build:client for packing, converting and minifying client side JavaScript files.
• gulp lint checks the code style. We use TSLint in combination with the standard.js coding standard.
• gulp test runs all tests.
• Source maps are automatically generated on build. This allows debugging of minified scripts in browser developer consoles

Roadmap

See ROADMAP.md

Contributing to this project

See CONTRIBUTING.md