Skip to content

A front end web application reporting data on police misconduct in the city of Chicago.

License

Notifications You must be signed in to change notification settings

rickyransom/ChiWatch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 

Repository files navigation

Overview

Chiwatch:

Reporting police misconduct in the city of Chicago from 2017-2020 with data sourced from The Thurgood Marshall Institute, the objective of this project is to inform, educate and enlighten concerned citizens on a growing problem in American cities today, by focusing on one of America's capital of the Midwest and a city rampant with violence. This project utilizes Airtable, ReactJS, and React-Chart

My Airtable

https://airtable.com/invite/l?inviteId=invBQvXuin6ZNqKYZ&inviteToken=b9c86d6b637c9b3e366396fc2abbf4bb76b89b6be42e4820ffe538e8b3d27341

Wireframes

Use the Wireframes section to display desktop, tablet and mobile views.

MVP

_The ChiWatch Minimum Viable Product of this project is to simply receive the user input, based on selected dataset filters (Year Of Complaint, Ethnicity of Complaintant, Category of Offense,etc) and output the visualization of that data in simple web application that emulates a social media post


Goals

  • _Render the info about the incident in a front end visual format that looks similar to Facebook status with a graph and portion of the table underneath
  • Have a graph or chart feature that shows the # of incidents by category vs the year.

Libraries

Use this section to list all supporting libraries and their role in the project.

Library Description
React Router Import data via AirTable using ReactRouter.
React Table Render the parts of the table relevant to the query
React JSON Graph Render a graph of complaint category in last three years._

Data

Use the Data Section to define the API(s) you will be consuming for your project, inluding sample URL queries.

API Quality Docs? Website Sample Query
AirtableAPI yes https://airtable.com/shr31XXeMsvYa6yqI

Component Hierarchy

src
|__ TheData/
      |__ Airtable
      |_Chart.js
      
|__ components/
      |__ Header.jsx
      |__ Nav. jsx
      |__ TheData.jsx
      |__ CSVReader.jsx
      |___ React-Graph.jsx
      |__ Footer.jsx

Component Breakdown

Use this section to go into further depth regarding your components, including breaking down the components as stateless or stateful, and considering the passing of data between those components.

Component Type state props Description
HTML, CSS, JS functional yes n Building the structure
Data functional yes n Working with the Airtable API
Status functional yes yes Will use a facebook status format to display officer name as username, and then information regarding the incident as status.
The Chart functional y y Chart the total number of complaints in that category
Footer functional n n _The footer will show info about me and the sources (Thurgood Marshall Institute of the data

Component Estimates

Use this section to estimate the time necessary to build out each of the components you've described above.

Time frames are key to the development cycle. You have limited time to code your app, and your estimates can then be used to evalute possibilities of your MVP and post-MVP based on time needed. It's best you assume an additional hour for each component, as well as a few hours added to the total time, to play it safe.

Task Priority Estimated Time Time Invested Actual Time
Structure M 2.5 hrs 3hrs TBD
React-Table M 2 hrs 2hrs TBD
React-Graph L 2 hrs 2hrs TBD
The Report /CRUD H 4 hrs 5hrs TBD
TOTAL 16.5 hrs 3 hrs TBD

Helper Functions

Use this section to document all helper functions– generic functions that can be reused in other applications.

Function Description
Capitalize _ ._

Post-MVP

_How do I allow users to add to this data by reporting their own incidents themselves, rather than rely on The Thurgood database? _Increase functionality by also allowing neighborhood watch feature to allow concernced citizen to report on false complaints or incidents of abuse of this tool, such as local trouble makers, burgulars or gang memebers who may file false or exaggertated complaints. _Add a feature to contact legislation in the city of Chicago with a contact form or digital suggestion box where citizens can suggest policies they would like to see implemented



Project Delivery

Code Showcase

Code that I am proud of while working on this project

Code Issues & Resolutions

Use this section to list of all major issues encountered and their resolution, if you'd like.

PERSONAL SWOT ANALYSIS

Strength

Passion for the subject Spent a lot of time over weekend practicing learning react all over again with a crash crash course so some things are fresh in my memory Read alot on recent data and also different examples of how data can be presented using React and React libraries.

Weakness

Still trying to fit all the knowledge in my head and struggling a little on when and where to apply components and which ones to apply or assessing if new files should be made for that component.

Opportunity

My weakness can be an opportunity to learn as we have more independent time and maybe gauge some more time for practice by experimenting with various libraries.

An opportunity to dive into AirTable features and functionality

Threats

My working environment, a physical rehabilitation/nursing home can sometimes be noisy or distracting. But I do my best during the day to utilize the quietest space.

Because of my working enviornment sometimes I am abruptly and without warning met with hinderances such as medical events or nurses.

Stress is always a threat and a weakness however all can be managed as long as i keep the right attitude

About

A front end web application reporting data on police misconduct in the city of Chicago.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published