alexanderturinske / cityscavenge

City Scavenge

City Scavenge is a real-time scavenger hunt application that will send you on a chase around your city to find a croissant before your competition does. It utilizes the Google Maps API to find your current location and place a croissant at a random interest area within two miles. Anyone can play, but you'll need to sign in with a Google account to begin your journey. Enjoy!

Table of Contents

1. Overview
2. Requirements
3. Installation
4. Deployment
5. Contributing
6. Meet the Engineers
7. Questions and Issues

=====================

Overview

Technologies

• React and Redux
• Socket.IO
• Node and Express
• PostgreSQL

Architecture

Schema

User data and saved places are managed in a Postgres database called city_scavenge.

=====================

Requirements

• Node 0.10.x
• PostgreSQL 9.5.2
• Google Maps API key
  • Enable the following Google APIs
    • Google Maps JavaScript API
    • Google Maps Embeded API
    • Google Maps Directions API
    • Google Maps Distance Matrix API
    • Google Maps Geocoding API
    • Google Maps API Web Service
    • Google Maps Elevation API
    • Google+ API
• Google OAuth 2.0 Client Credentials

=====================

Installation

From within the root directory, install the global dependencies and the local dependencies

$ npm install -g nodemon webpack grunt
$ npm install

Setting up the database

First start your PostgreSQL server

Next, from within the root directory, create the database and tables in PostgreSQL

$ psql -f server/schema.sql

Setting up the Google API keys

Add your Google API credentials to the config files in /server/config, following the format of the example files.

Remove .example from the filename.

Running Locally

Compile client-side code and start the server

$ npm start

Visit localhost:1337 in the browser.

Testing

First install all dependencies

$ npm install

Now run the tests

$ npm test

=====================

Contributing

City Scavenge was built using waffle.io as the project organization tool. See CONTRIBUTING.md for contribution guidelines.

=====================

Meet The Engineers

Product Owner

• Michael Balarezo

Scrum Master

• Alexander Turinske

Development Team

• Genevieve Sublette

=====================

Questions and Issues

For any issues, please refer to our issues page Please direct any questions regarding City Scavenge to our wiki page

Thank you!