/Vime

Primary LanguageJavaScript

Project Name

Vime

Team

  • The Better Team Members: Carl Chen, June Won, Keith Wong, France Yang
  • Legacy Team Members: Billy Lan, Michael De La Cruz, Edmund To, Clay Han

Table of Contents

  1. Requirements
  2. Development
    1. Installing Dependencies
  1. Team

Requirements

  • Node 4.4.7
  • PostgreSQL or MySQL
  • Chrome 49.0 or Firefox 25.0

Development

Installing Dependencies

From within the root directory:

Install all npm dependencies.

npm install
npm run postinstall

Using PostgreSQL or MySQL, create a database for the project (we call it greenfield):

CREATE DATABASE greenfield;

Populate the database with questions for the user.

npm run seed

Initiate webpack.

npm run build:dev

Open the server with Nodemon.

npm start

Once the app is up and running, you will need to create an Amazon S3 account to host recorded videos. https://aws.amazon.com/s3/

Create a S3 Bucket with the region US Standard Navigate to the bucket and click properties, update the CORS with the following

  <AllowedOrigin>*</AllowedOrigin>
  <AllowedMethod>HEAD</AllowedMethod>
  <AllowedMethod>GET</AllowedMethod>
  <AllowedMethod>PUT</AllowedMethod>
  <AllowedMethod>POST</AllowedMethod>
  <AllowedMethod>DELETE</AllowedMethod>
  <AllowedHeader>*</AllowedHeader>

In your root directory, create a .env file.

touch .env

Inside of the .env file, provide the ACCESS_KEY_ID, SECRET_ACCESS_KEY, and AWS_BUCKET. You can create an AWS bucket inside of the S3 account. You .env file should look like this:

ACCESS_KEY_ID=<your-access-key-id>
SECRET_ACCESS_KEY=<your-secret-access-key>
AWS_BUCKET=<your-aws-bucket>

In order to push to Heroku, setup Heroku config variables (see above) as well as setup for Heroku Postgres addon https://elements.heroku.com/addons/heroku-postgresql

If you choose to run Webpack on production, run the following command to allow heroku to install devDependencies

heroku config:set --app <your app name> NPM_CONFIG_PRODUCTION=false