The project description

• Aaron Xavier
• Alex Matranga
• Eric Pan
• Josh Stagner

View the project roadmap here

See CONTRIBUTING.md for contribution guidelines.

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks

Some usage instructions

• Node 6.9.x
• Redis 3.2.x
• Postgresql 9.6.x
• etc

brew install yarn
brew install redis
brew install postgresql

Yarn is a replacement for npm. It's faster and guarantees consistency -- as you deploy your code in various environments, you won't run the risk of slight variations in what gets installed.

yarn global add grunt-cli knex eslint

IMPORTANT: ensure postgres is running before performing these steps.

create a new database for your development and test environments:

Development envronment: createdb YOUR_DEVEL_DATABASE

Other environments, specify like so: createdb testing_db

In terminal, from the root directory:

export NODE_ENV=development && knex migrate:latest

export NODE_ENV=development knex migrate:rollback

export NODE_ENV=development && knex seed:run

export NODE_ENV=test && knex migrate:latest

Heroku run knex migrate:latest --app pepclock-staging

Note: --env NODE_ENV may be omitted for development. For example, knex migrate:latest will run all migrations in the development environment, while export NODE_ENV=development && knex migrate:latest will migrate in the test environment.

In a Heroku Scheduler for the app, use this as the command:

curl [app url]/api/workers/invites [app url]/api/workers/recipients

Where for example if the app is pepclock-staging use:

curl https://pepclock-staging.herokuapp.com/api/workers/invites https://pepclock-staging.herokuapp.com/api/workers/recipients

Where for example if the app is pepclock use:

curl https://pepclock.herokuapp.com/api/workers/invites https://pepclock.herokuapp.com/api/workers/recipients

To run webpack build: yarn run build

To run server: yarn run start:dev

To run tests: yarn run test

To run your redis server for the session store redis-server