Foursquared

Get Started

• Install Node.js and Yarn.
  • Note the step to put this line in your shell profile export PATH="$PATH:$(yarn global bin)".
• Clone this repo.
  • If you previously cloned this repo when it was under Henry's account, run git remote set-url origin git@github.com:tommyang/FourSquared.git if you use SSH or git remote set-url origin https://github.com/tommyang/FourSquared.git if you use HTTPS.
• Install local dependencies $ yarn.
• Install these if you want to run end-to-end tests locally:
  • $ yarn global add gulp-cli phantomjs.
  • Install Selenium Standalone Server.
• Write tests in /test, preferrably with the following naming conventions:
  • test-xxx.js for unit tests. See test-foo.js for an example.
  • e2e-xxx.js for end-to-end tests. See e2e-password.js for an example.
• Write code. See foo.js for an example.
• To start the server locally, run $ yarn start and got to http://localhost:3000.
• To run the tests:
  • To run unit tests only, run $ yarn unit.
  • To run end-to-end tests only, make sure the server is not running, start Selenium Standalone Server, and then run $ yarn e2e.
  • To run all tests, make sure the server is not running, start Selenium Standalone Server, and then run $ yarn test.
• Commit and push. Travis CI will run the tests using Mocha. Test coverage information is tracked by Code Climate. If tests return successfully, Travis will deploy this version to Heroku automatically.
  • If you are pushing commits with just "cosmetic changes" (such as updating this README file), include [ci skip] in the commit message to skip Travis CI.
• Check #commits Slack channel for Travis CI status report.