You can find the deployed project at Human Rights First - Police Brutality Across America and a product demo video here
Matthew Molloy | Jason Schwartz | Emilio Diaz-Goico | Steele Helbling |
---|---|---|---|
Technical Architecture and Userflow
Our team is developing an interactive map that identifies instances of police use of force across the United States of America for Human Rights First, an independent advocacy and action organization.
- User can view incidents of police brutality and get more information on specific incidents
- User can currently search map based on city and state. In future releases, filters based on type of force and date could be implemented.
In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:
* REACT_APP_BACKENDURL=
link to API endpoint to retrieve data
* REACT_APP_MAPBOX_TOKEN=
mapbox token for accessing mapbox API - generate new token at mapbox.com
No testing implemented as of October 23rd, 2020.
Run 'npm install' to install all necessary dependencies.
* node server.js - must be executed from /server folder - runs local server for development
When contributing to this repository, please first discuss the change you wish to make via the 'issue' tab or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Navigate to the 'issues' tab to submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Backend Documentation for details on the backend of our project.
See Data Science Documentation for details on the data science portion of our project.