flashback is Instagram meets Pokemon Go!

• Paul Dockery
• Joseph Lei
• Steve Leung
• Sara Daqiq

View the project roadmap here

View the App Plan here

See CONTRIBUTING.md for contribution guidelines.

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

Some usage instructions

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

brew install yarn
brew install redis
brew install postgresql
yarn install

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

Override settings config/default.json in any environment by making a copy of config/ENV.example.json and naming it config/ENV.json and setting the appropriate variable.

For environments that require use of environment variables, you can supply variables as defined in config/custom-environment-variables.json.

See https://www.npmjs.com/package/config And https://github.com/lorenwest/node-config/wiki/Environment-Variables#custom-environment-variables

IMPORTANT: ensure postgres is running before performing these steps.

Use grunt to create a new database for your development and test environments:

Development envronment: grunt pgcreatedb:default

Other environments, specify like so: NODE_ENV=test grunt pgcreatedb:default

In terminal, from the root directory:

To migrate to the latest version, run:

knex migrate:latest --env NODE_ENV

To rollback a version, run:

knex migrate:rollback --env NODE_ENV

To populate the database with seed data, run:

knex seed:run --env NODE_ENV

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

To run webpack build: yarn run build

To run server: yarn run start

To run development server: yarn run dev-start

To run tests: yarn run test

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