jkawahara / bcbc-project1 Goto Github PK

Branch name 'doc-readme'

User Story: As user and developer, detailed README.md is needed to describe the project.

Acceptance Criteria: README.md components

• Getting Started- Why/What/How
• Versioning
• Authors
• License
• Acknowledgments

Tasks:

1. Read data queried from DataSF API
2. Determine which objects (assault, theft, burglary, robbery, vehicle theft), representing danger spots
3. Integrate heatmap layer on main route map

Acceptance criteria:

1. Verify queried DataSF object arrays represent longitude & lattitude points as expected by Map API
2. Only selected objects are displayed on heatmap
3. Selecting heatmap button overlays heatmap over main route map

Example:

• Interface

  • 

• Code

  • https://jsbin.com/nakozud/1/edit?html,css,js,console,output

Creating a secondary pop-up window with call emergency button - report/call taxi?

1. Google maps for navigation/routing
2. Mapbox for visualization
3. Data SF for crimes info
   4.MapQuest?

Tasks:

• Replace Firebase SDK link
  • <script src="https://www.gstatic.com/firebasejs/5.5.9/firebase.js"></script>
• with:
  • <script src="https://www.gstatic.com/firebasejs/5.5.9/firebase-app.js"></script>
  • <script src="https://www.gstatic.com/firebasejs/5.5.9/firebase-database.js"></script>

Currently receive Firebase SDK notification in console.log when page is loaded initially or refreshed

Working on mobile sizing and proper scaling based on mobile device.

Put a href link to create a responsive 911 button, which calls for Facetime on your phone/tablet.

Tasks:
-For consistency, add all API keys into eventual config.js and assign global variables to be used in main js.js
-Document in README.md
Verifications:
-script link to config.js in index.html, placed just above script link to js.js
-config.js added to .gitignore to ensure config.js is not tracked nor pushed into GitHub remote repo.

This will prevent our API keys being leveraged by others.

To Reproduce
Currently, Firebase API key has been committed in master and viewable in GitHub repo (commit cd68f58)