README.md

7uyhb # Project Name

Rally - Building A Distributed Network With Your Browser

Table of Contents

1. Requirements
2. Development
   1. Installing Dependencies
3. Team
4. Notes for Development Team

Team

• Development Team Members: Frank Lee, Edmund To, Leah Loversky, Clay Han

Requirements

• Node 4.4.7
• PostgreSQL

Installing Dependencies

Install all npm dependencies.

npm install

Download/launch Postgres app and create a database named 'rally' http://postgresapp.com/

open psql

CREATE DATABASE rally;

Create client/src/environment/ folder with a file called environment.js. Add the following code to environment.js, replacing empty strings with firebase config variables:

const ENV = {
  apiKey: '',
  authDomain: '',
  databaseURL: '',
  storageBucket: ''
};

export { ENV };

Initiate webpack.

npm run build: dev

Initiate nodemon.

npm start

OPTIONAL: Run Webpack and Nodemon at once:

npm run build:start

Testing

1. To add new tests, create a file containing your tests in 'client/src/tests/' with the suffix '-test' (see existing files for examples)
2. To execute tests, run 'npm test' from the command line
3. Note: Karma will launch and close Chrome each time you run the tests; this typically takes about 10 seconds. If you'd like Chrome to stay open, change the 'singleRun' option to false in karma.conf.js

Notes for Development Team

1. Socket event handlers for server:

• 'disconnect': user disconnected its socket connection
• 'userReady': user is ready to receive Job
• 'userDisconnect': user leaves a project
• 'userJobDone': user sent back a finished Job
• 'createProject': need to instantiate a new Project
• 'getAllProjects': user is requesting list of all Projects
• 'error'

2. Socket event handlers for client:

• 'newJob': received new Job from server
• 'updateWorkers': received list of all workers
• 'updateResults': received array of all results so far
• 'finalResult': Project has concluded and received final result
• 'allProjects': received a list of all project IDs from server