https://github.com/justinharringa/neighborhood-map

Single-page app that shows music venue locations around San Francisco
https://github.com/justinharringa/neighborhood-map

Last synced: 7 days ago
JSON representation

Single-page app that shows music venue locations around San Francisco

• Host: GitHub
• URL: https://github.com/justinharringa/neighborhood-map
• Owner: justinharringa
• License: mit
• Created: 2016-10-31T03:47:27.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-09-19T20:21:15.000Z (over 7 years ago)
• Last Synced: 2024-11-08T13:52:14.504Z (2 months ago)
• Language: JavaScript
• Size: 60.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# neighborhood-map

Single-page app that shows music venue locations around San Francisco

[![Build Status](https://travis-ci.org/justinharringa/neighborhood-map.svg?branch=master)](https://travis-ci.org/justinharringa/neighborhood-map)

Powered by [![SeatGeek](src/img/seatgeek-102x19.png)](https://www.seatgeek.com)

# Getting Started

## Install Node.js

You should install Node.js AND update npm following 

[these instructions](https://docs.npmjs.com/getting-started/installing-node).

## Install Dependencies

You will just need to run `npm install` to download the dependencies so 

long as you have installed Node.js and updated npm as per the 

instructions referenced above.

## Running unit tests

**NOTE**: Chrome must be installed on any system with this configuration

Using [grunt-karma](https://github.com/karma-runner/grunt-karma) and

[karma-jasmine](https://github.com/karma-runner/karma-jasmine) to run 

[Jasmine](https://jasmine.github.io/) unit test specs.

Simply run `grunt karma` to run the unit tests.

## Usage 

### Build the project

Running `grunt` will clean and copy files to the `dist` directory and 

will also generate responsive files for all images.

### Check PageSpeed Insights

Simply run `grunt psi-ngrok` to get PageSpeed Insights output

### Load via HTTP server to profile

If you'd like the local code accessible on the web, run the following 

command from the root directory of the project to be able to load via 

an HTTP Server:

```grunt http-server:dev```

# Bootstrap for Responsiveness

The neighborhood map was built on Twitter's Bootstrap framework.

* Bootstrap's CSS Classes

* Bootstrap's Components

# Powered by [![SeatGeek](src/img/seatgeek-102x19.png)](https://www.seatgeek.com)

Using [SeatGeek](https://www.seatgeek.com)'s API for venues.

# Additional APIs / Frameworks

* [Google Maps API - Javascript](https://developers.google.com/maps/documentation/javascript/)

* [Knockout](http://knockoutjs.com/)