Parker Illig : pail4944
Daniel Maxson : Boraz
Andy Rutherford: andrewrutherford
Byron Bearden: bybe2937
Griffith Neumark: grne8000
##Repo Organization
-Our root directory contains our main page, index.html, and our two other html pages, about.html and testing.html.
-All the Javascript files live in the js directory.
-The CSS files live in the css directory.
-The graphics we use on the site are stored in the assets directory.
-The auto-doc generation is contained in the doc directory.
##Description
Our goal for this project is to use the Yelp API to provide a rich individual experience through maps and graphs, including a more personalized approach to Yelp recommendations.
##Vision Statement
"Helping you go where you wanna go"
##Motivation
Making a more personalized Yelp experience that allows users to save their favorite places and provides enhanced graphical fidelity and location visualization.
##Risks
-Breaking one of Yelp's API use guidelines (https://www.yelp.com/developers/display_requirements)
-Calling API too many times
-Never collaborated on GitHub before (pail4944, anru9411)
###Mitigation Strategy
-Making sure we use Yelp's logos and buttons on every page
-Hopefully a low traffic count, bandwidth management
-Good communication through Slack, GitHub and Pivotal Tracker (pail4944)
##Requirements ####User Requirements
| ID | Requirement | Time Req |
|---|---|---|
| 1 | As a user, I want to find locations in an intuitive manner | 2 |
| 2 | As a user, I want to filter locations so that I can view results relevant to me | 3 |
| 3 | As a user, I want to graphically see locations so that I can see them on a map | 4 |
| 4 | As a user, I want to save locations so I can view them again at a later time | 7 |
| 5 | As a user, I want to access a personalized profile so that I can edit information and see saved locations | 5 |
####Functional Requirements
| ID | Requirement | Time Req |
|---|---|---|
| 6 | As a developer, I want to build a basic HTML page, which will serve as a foundation of the website | 1 |
| 7 | As a developer, I want to create buttons and forms so that the user can find and filter locations | 4 |
| 8 | As a developer, I want to show graphs and maps so that the user has a visual context to his/her results | 5 |
| 9 | As a developer, I want to show markers on the graphs so that the user can see detailed information on the map | 5 |
| 10 | As a developer, I want to build user profiles so that the user can access a personal profile, map, results, etc. | 6 |
####Non-Functional Requirements
| ID | Requirement | Time Req |
|---|---|---|
| 11 | As a developer, I want favorites to show up on user profiles within 30 seconds because fast is better than slow | 5? |
##Methodology
We plan on using a agile format where we add and test smaller features over time rather than doing all production at once.
##Project Tracker
https://www.pivotaltracker.com/n/projects/1538859
##Project Plan
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent