This is a Sprout-based project!

Please populate this Markdown-based README with information pertinent to your project!

First, make sure you have access to the PointSource NPM registry. Check here for details.

Next, install sprout-cli. Sprout is available from PointSource's private npm registry. You can install it by running:

npm install -g sprout-cli

Alternatively, the beta version of sprout is also available through npm:

npm install -g sprout-cli@beta

However, the latest non-beta version should be acceptable.

git clone git@github.com:PointSource/MasterMind.git
cd MasterMind
git checkout newsprout

sprout npm install
sprout bower install
cd client
npm install
cd ..

Ideally all of these will be replaced in future versions of sprout-cli with simply sprout install.

sprout project start

For the client:

cd client
gulp

For the server:

cd server
nodemon

The client will be running at http://localhost:8080. You can login at http://localhost:8080/login.html. The client gulp server will proxy any API requests at /v3 (e.g. http://localhost:8080/v3/tasks).

The server is running at http://localhost:3000. If you've authenticated via the client and visit an API endpoint, the proper cookies should be sent to consider you authenticated, but it might be simplest to use the aforementioned proxy to more closely replicate what a production scenario would be like.

A convenient swagger specification viewer / testing utility is available at http://localhost:8080/docs/index.html.

Please use JSHint and JSCS to validate the style in any additions to this codebase. Editor plugins are available, look here and here.

Want to help yourself make sure that you don't check in any badly styled code? Trying copying in the provided pre-commit hook. Make sure you install jscs and jshint globally!

From the root of your repository:

npm install -g jscs jshint
cp .pre-commit-hook .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

Now, anytime you try to commit, JSCS and JSHint will automatically run against any .js files that are staged!

To run the REST tests, install mocha, casperjs, and phantomjs globally:

npm install -g mocha casperjs phantomjs

Use the sprout test command, but make sure you pass the needed environment variables (these are the standard set useful for automated testing):

USER_GUSER="psapps2@pointsourcellc.com" USER_GPASSWD="PSapps123" ADMIN_GUSER="psapps@pointsourcellc.com" ADMIN_GPASSWD="ps@pp\$777" sprout test

Alternatively, run the test script directly:

USER_GUSER="psapps2@pointsourcellc.com" USER_GPASSWD="PSapps123" ADMIN_GUSER="psapps@pointsourcellc.com" ADMIN_GPASSWD="ps@pp\$777" node server/test/runTests.js