You can find the deployed project at Human Rights First - Police Brutality Across America.
| Mark Rivera | Michael Rockingham | Jen Stewart | Anthony Carrillo | |
|---|---|---|---|---|
 |
 |
|||
 |
|
|
|
|
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 seearch map based on type of force, location, and date
- Pandas
- scikit-learn
- spacy
- nltk
- PRAW
- Tweepy
- Works well with FastAPI
- Recommended to us
- Wanted to learn an in-demand framework
Back end built using:
"@okta/jwt-verifier": "^1.0.0",
"axios": "^0.19.2",
"cookie-parser": "~1.4.4",
"cors": "^2.8.5",
"debug": "~2.6.9",
"dotenv": "^8.2.0",
"express": "^4.16.4",
"faker": "^4.1.0",
"helmet": "^3.23.1",
"http-errors": "~1.6.3",
"json2csv": "^5.0.5",
"knex": "^0.21.6",
"luxon": "^1.25.0",
"morgan": "~1.9.1",
"node-cron": "^2.0.3",
"pg": "^8.2.1",
"swagger-jsdoc": "^4.0.0",
"swagger-ui-express": "^4.1.4"
We are sending json objects to the backend with information about instances of police use of force. This information includes location data (city, state, and geocode) and relevant details about the incident, like the type of force that was used.
PRAW, The Python Reddit API Wrapper, makes it easy for users to analyze Reddit data. We used PRAW to scrape Reddit for potential instances of police of force.
Tweepy is a Python library that allows users to access the Twitter API. We used Tweepy to scan Twitter to find instances of police use of force.
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:
OKTA_URL_ISSUER = https://auth.lambdalabs.dev/oauth2/default
OKTA_CLIENT_ID = 0oalwp37fU2aV9UEG4x6
DATABASE_URL = postgres://ugkakqld:oZSXjtaGFA1r1psfCfIfv1ZEJID1j4KM@raja.db.elephantsql.com:5432/ugkakqld?ssl=true
No testing implemented as of January 31st, 2021.
Run 'npm install' to install all necessary dependencies.
* npm run server - must be executed from /server folder - runs local server for development
* npm run cleardb - must be executed from /server folder - deletes all records from Incidents table
* npm run initialfetch - must be executed from /server folder - performs initial population of Incidents table
When contributing to this repository, please first discuss the change you wish to make via issue, email, 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.
- 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 Frontend Documentation for details on the frontend of our project.