Human Rights First: Police Brutality Across America

You can find the deployed project at Human Rights First - Police Brutality Across America.

Contributors

Matthew Molloy	Jason Schwartz	Emilio Diaz-Goico	Steele Helbling

Project Overview

Trello Board

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.

Key Features

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

1️⃣ Tech Stack

Data Science API built using:

Data Science goes here

🚫 Why did you choose this framework?

Works well with FastAPI
Recommended to us
Wanted to learn an in-demand framework

🚫List the rest of the data science features and libraries in the same format as the framework above.

Pandas
scikit-learn
spacy
nltk
PRAW
Tweepy

Data Science API deployed to AWS

[Back end](🚫link to back end repo here) built using:

🚫 back end framework goes here (link to BE REPO)

dependencies

@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
knex: ^0.21.6
morgan: ~1.9.1
pg: ^8.2.1
swagger-jsdoc: ^4.0.0
swagger-ui-express: ^4.1.4

incidents table

Name	Type	Required	Description
incident_id	increments	Yes	records the number of the entreys
id	String	Yes	gives it unque id
city	String	Yes	gives the city the incident took place
state	String	Yes	gives the state the incident took place
lat	float	Yes	gives the latitude of the incident on the world map
long	float	Yes	gives the longitude of the incident on the world map
title	String	Yes	gives the title of the incident
desc	varchar	No	gives the description of the incident
date	date	No	gives the date of the incident

sources table

Name	Type	Required	Description
src_id	increments	Yes	records the number of the entreys
incident_id	integer	No	gives it unque id
src_url	String	No	gives url of the incident
src_type	String	No	gives url type

incident_type_of_force table

Name	Type	Required	Description
itof_id	increments	Yes	records the number of the entreys
type_of_force_id	integer	Yes	gives it unque id
incident_id	integer	Yes	key tells it what incident it is

type_of_force table

Name	Type	Required	Description
type_of_force_id	increments	No	key tells it what incident_type_of_force it is
type_of_force	String	No	gives type of force tag

Example

{
    "incident_id": "Test",
    "id": "Test",
    "city": "test",
    "state": "test"
    "lat": "test"
    "long": "test"
    "title": "test"
    "desc": "test"
    "date": "test"
}

Responses:

/showallincidents Will receive a 200 (OK) response with an array of incidents if the request is successful

[
  {
    "incident_id": "Test",
    "id": "Test",
    "city": "test",
    "state": "test"
    "lat": "test"
    "long": "test"
    "title": "test"
    "desc": "test"
    "date": "test"
  },
  {
    "incident_id": "Test",
    "id": "Test",
    "city": "test",
    "state": "test"
    "lat": "test"
    "long": "test"
    "title": "test"
    "desc": "test"
    "date": "test"
  },
];

Will receive a 500 (Internal Server Error) response if there is an issue with grabing the data

{
  "message": "Request Error"
}

/createincidents Will receive a 201 (Created) response along wtih the newly created incident if successful

[
  {
    "incident_id": "Test",
    "id": "Test",
    "city": "test",
    "state": "test"
    "lat": "test"
    "long": "test"
    "title": "test"
    "desc": "test"
    "date": "test"
  },
];

Will receive a 500 (Internal Server Error) response if there is an issue with the API server

{
    "message": "Error creating Record"
}

/sources Will receive a 200 (OK) response with an array of sources if the request is successful

[
  {
    "src_id": "Test",
    "incident_id": "Test",
    "src_url": "test",
    "src_type": "test"
  },
  {
    "src_id": "Test",
    "incident_id": "Test",
    "src_url": "test",
    "src_type": "test"

  },
  {
    "src_id": "Test",
    "incident_id": "Test",
    "src_url": "test",
    "src_type": "test"
  },
];

Will receive a 500 (Internal Server Error) response if there is an issue with grabing the data

{
  "message": "Request Error"
}

/tags Will receive a 200 (OK) response with an array of tags if the request is successful

[
  {
    "itof_id": "Test",
    "type_of_force_id": "Test",
    "incident_id": "test",
  },
  {
    "itof_id": "Test",
    "type_of_force_id": "Test",
    "incident_id": "test",

  },
  {
    "itof_id": "Test",
    "type_of_force_id": "Test",
    "incident_id": "test",
  },
];

Will receive a 500 (Internal Server Error) response if there is an issue with grabing the data

{
  "message": "Request Error"
}

/tagtypes Will receive a 200 (OK) response with an array of tagtypes if the request is successful

[
  {
    "type_of_force_id": "test"
    "type_of_force": "test"
  },
  {
    "type_of_force_id": "test"
    "type_of_force": "test"

  },
  {
    "type_of_force_id": "test"
    "type_of_force": "test"
  },
];

Will receive a 500 (Internal Server Error) response if there is an issue with grabing the data

{
  "message": "Request Error"
}

/sources/:id Will receive a 200 (OK) response with an array of tagtypes if the request is successful

[
  {
    "src_id": "Test",
    "incident_id": "Test",
    "src_url": "test",
    "src_type": "test"
  },
];

Will receive a 500 (Internal Server Error) response if there is an issue with grabing the data

{
  "message": "Request Error"
}

/createsource Will receive a 201 (Created) response along wtih the newly created incident if successful

[
    "src_id": "Test",
    "incident_id": "Test",
    "src_url": "test",
    "src_type": "test"
  },
];

Will receive a 500 (Internal Server Error) response if there is an issue with the API server

{
    "message": "Error creating Record"
}

APIs

2️⃣ Data Science API

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.

2️⃣ PRAW

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.

3️⃣ Tweepy

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.

3️⃣ Environment Variables

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

Testing

No testing implemented as of October 16th, 2020.

Installation Instructions

Run 'npm install' to install all necessary dependencies.

Other Scripts

* node server.js - must be executed from /server folder - runs local server for development

Contributing

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.

Issue/Bug Request

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.

Feature Requests

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.

Pull Requests

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.

Pull Request Guidelines

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.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Frontend Documentation for details on the frontend of our project.

BloomTech-Labs/human-rights-first-be-c

Human Rights First: Police Brutality Across America

Contributors

Project Overview

Key Features

1️⃣ Tech Stack

Data Science API built using:

Data Science goes here

Data Science API deployed to AWS

[Back end](🚫link to back end repo here) built using:

🚫 back end framework goes here (link to BE REPO)

dependencies

incidents table

sources table

incident_type_of_force table

type_of_force table

Example

Responses:

APIs

2️⃣ Data Science API

2️⃣ PRAW

3️⃣ Tweepy

3️⃣ Environment Variables

Testing

Installation Instructions

Other Scripts

Contributing

Issue/Bug Request

Feature Requests

Pull Requests

Pull Request Guidelines

Attribution

Documentation