DGKeep

Configurable API for tracking golf scores

Environment

The following instructions are for OSX development environments.

This project uses NPM to manage its dependencies, to set up your development environment run npm install.

This project uses Sequalize as an RDBMS so it can handle most relational databases, the test suite is run against a PostgreSQL backend so that must be setup as well.

brew install postgresql
initdb /usr/local/var/postgres -E utf8
mkdir -p ~/Library/LaunchAgents
cp /usr/local/Cellar/postgresql/9.4.1/homebrew.mxcl.postgresql.plist ~/Library/LaunchAgents/
launchctl load -w ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist
createdb dgkeep_test
createdb dgkeep_dev
psql -c 'CREATE ROLE postgres LOGIN;' dgkeep_test

Install dependencies by running npm install. Run the tests using npm test.

Testing

All tests are run against the dgkeep_test database which will be wiped clean before each test.

Please note that all Sequelize logging is routed to logs/sequelize.log, in order to make debugging clearer, this log is wiped at the start of testing. If you are doing development and wish to hold onto this log make sure to create a copy before running npm test.

Logger output from testing can be found at logs/test.log Logger output from Sequelize can be found at logs/sequelize.log