collinjackson93 / Locale

Find Where You Belong

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Locale

Finds your perfect neighborhood.

Uses the Chicago Tribune crime data API, along with Trulia and Google Places.

Users answer a series of fun questions, similar to a Buzzfeed quiz. Based on their responses, the application determines their preferences for several metrics, including crime, nightlife, price, and more. It then ranks the communities of select large cities by how well they fit the user's preferences and displays them on a map of the city, with information about each.

Docker

Run docker build -t locale . whenever there is a code change. To start the application, run docker run --rm -p 8080:8080 locale. To run tests, run docker run --rm locale npm test.

Tests

Run npm test to run all unit tests, including JSHint and JSCS.

Coding Style

This project uses a lightly modified version of the node-style-guide. Make sure your JavaScript conforms to the appropriate style by running npm test. If you feel like the style requirements should be modified, the documentation for JSCS can be found here. Additionally, in the unlikely event that JSHint options need to be modified, here is that documentation. The options must be placed in the appropriate .*rc file.

About

Find Where You Belong

License:MIT License


Languages

Language:HTML 45.3%Language:CSS 28.5%Language:JavaScript 25.9%Language:Python 0.2%Language:Ruby 0.1%Language:PowerShell 0.0%Language:Shell 0.0%