nhi-ngo / v26-geckos-team-02

:world_map:: State of Safety App | Voyage-26 | https://chingu.io/

Knowledge = safety, Safety = power. Be in a State of Safety. SOS gives you access to the crime data in your state.

This app displays historical US state-level data from the FBI Crime Data API to show trends for several types of crimes.

Wireframes

User Stories for MVP

• Select the state from the dropdown list of states
• Select the specific state on the interactive map
• Click on "Locate Me" to be automatically located
• Be able to filter through various crime criteria (year range and crime type) to learn more about specific crimes that are of direct concern
• A line chart to show the crime data for selected crime type
• See the current selected state on the map by area

Dependencies

React, Material UI, D3, Axios

API

• FBI Crime Data API
• Mapbox

Installation

Clone the repository to your local machine:

git clone https://github.com/chingu-voyages/v26-geckos-team-02.git

Cd into the new directory:

cd v26-geckos-team-02

Install dependencies:

npm i

Create a .env file with a FBI Crime Data API key and Mapbox access token (see .env.sample file)

Start the app locally:

npm start

Contribute

Feel free to open a PR or fork this project and modify it as you wish!

Authors

Product Owner: David, Developers: Dario, Jennifer, Nhi

State of Safety App | Voyage-26 | https://chingu.io/ | Twitter: https://twitter.com/ChinguCollabs | Netlify: https://sosstateofsafety.netlify.app/