infoMapp

Infomapp allows users to select a location on a map and receive information and trends analysis for the area.

Team

• Kaiser Wu
• Andy Qi
• Amy Loftus

Table of Contents

1. Usage
2. Requirements
3. [Getting Started](#Getting Started)
4. Development
   1. Installing Dependencies
5. Roadmap
6. [Style Guide](#Style Guide)
7. Contributing

Usage

The app is made with a SERN stack and makes use of axios to handle http requests.

Requirements

Make sure to have these installed on your computer:

• Node
• MySQL
• Webpack

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

1. Fork the repo from https://github.com/uranus84/neptune-team
2. Clone down your forked repo to your local machine
3. Install the dependencies

Development

Installing Dependencies

Once you have forked the repo from https://github.com/uranus84/neptune-team , install all the dependencies by running.

From within the root directory:

npm install

Getting the tokens for the API calls

We use Google Maps, Twitter, Walkable, and Indico API’s to collect the data, so you will need API keys for them to make requests.

Roadmap

View the project roadmap here

Style Guide

We are following the Hack Reactor style guide, which can be found here

Contributing

To contribute to this repo, see CONTRIBUTING.md for contribution guidelines.