README.md

In Search of Happiness

A single page web app to help developers find their dream company to work for.

To use

Visit the site on Heroku here.

To run locally

On OSX:

You will need MongoDB, npm, the Java SDK, and Selenium Standalone Server installed to start.

git clone https://github.com/danielemanuel/in_search_of_happiness
cd in_search_of_happiness
npm install
cd react-ui
npm install

If you have Homebrew installed, we provide a convenience script to install and set up Mongo and Selenium as background processes: npm run setup.

You can seed your database using the Glassdoor API with npm run db-download.

Once everything is installed, run npm run start-servers from the project root to host the project locally.

To run tests

• Everything: npm test
• Front End: npm run test-frontend
• Back End: npm run test-backend

Note that our front end tests rely on the project servers, so use npm run start-servers before running them.

The App

• Node API server with Express on backend.
• React server on the front end that compiles to static files for production.
• Heroku for site hosting.
• mLab for storing production db in the cloud.

Our tech stack

Framework:

• MongoDB
• Express
• React
• Node

Graphics:

• D3 and D3-Force
• Chart.js
• Bootstrap

Other:

• React Router DOM
• Mongoose

Test harness:

Back End

• Zombie
• Jasmine

Front End

• Selenium Standalone Server
• Webdriver.io
• Mocha
• Chai

Contributors:

• Sam Blausten
• Chris Mitchell
• Alexander Chalk
• Daniel Costea