cribbage-analyst

Two-player cribbage discard analysis tool.

Installation

• Install Node.js 8 LTS or Node.js 6 LTS;
• clone this Git repository; then
• run npm install to download project operational and development dependencies.

Execution

• Server: node_modules/.bin/gulp startServer &.
• Client: open index.html in an ECMAScript 5 Array.prototype supporting (IE9+, Safari 5+, any recent Chrome or Firefox, etc.) web browser. :)

Developer setup

To execute the standard code quality checks of the project, bundle all JavaScript, make the webapp deployable and generate code documentation via JSHint, Jasmine, JSCS, gulp-coverage), JSDoc, webpack and Nightwatch:

• add node_modules/chromedriver/lib/chromedriver to your PATH environment variable in order to make ChromeDriver findable,
• run node_modules/.bin/gulp startServer in the background, then
• run node_modules/.bin/gulp.

To instead test with Firefox add node_modules/geckodriver to PATH, set nightwatch.conf.js "browserName" to "firefox". To instead test with headless Firefox set the MOZ_HEADLESS environment variable to 1 before starting gulp.

To test with Microsoft Edge on Windows 10 (real or testing virtual machine) add node_modules/edgedriver/lib/edgedriver to PATH and set nightwatch.conf.js "browserName" to MicrosoftEdge.

To have the above project build steps always run and be verified to have run successfully before Git accepts a git commit:

• copy .git/hooks/pre-commit.sample to .git/hooks/pre-commit, then
• add one line to the end of .git/hooks/pre-commit which reads node_modules/.bin/gulp.