PoliceConduct.org

👨🏻‍✈️ A citizen public records platform where you can view, edit, modify and delete details for your very own police incidents, good or bad.
View Demo
Explore the docs »
Report Bug Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Helpful Tools & Resources
9. Acknowledgments

About The Project

Submitting a report on an interaction you had with a specific police officer is not a user friendly process. It involves physically going into a precinct and filing a report, which comes with its own complications and challenges.

PoliceConduct.org is an online application that allows citizens to easily complete a report on an interaction they had with a specific police officer. It’s a simple, easy, user friendly option that streamlines this process. The platform is inherently unbiased - it does not care whether the interaction you are reporting was good or bad. It presents you with the steps you need to submit a report and can allow this data to become public.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

0. This project was tested using Chromium browsers.

1. Create a database named 'prime_police'. The project is built on Postgres, so you will need to make sure to have that installed. Using Postico is recommended to run queries as that was used to create the test queries.

2. Setup a free or paid account on SendGrid API.

3. Clone the repo by HTTPS:

   git clone https://github.com/marc-mccarthy/police-conduct.git

   or via SSH:

   git clone [email protected]:marc-mccarthy/police-conduct.git

   or by CLI:

   git clone gh repo clone marc-mccarthy/police-conduct

4. Enter all your credentials into your '.env' file (Don't include quotes):

   • Server Session Secret

   SERVER_SESSION_SECRET='A RANDOM PHRASE OVER 8 CHARACTERS'

   • SendGrid API

   SENDGRID_API_KEY='KEY SUPPLIED BY SENDGRID UPON REGISTRATION'
   SENDGRID_API_KEY_EMAIL='EMAIL ADDRESS THAT YOU WANT EMAILS SENT TO'

   • Heroku Deployment (Optional)

   DATABASE_URL=postgres://username:password@host:port/database_name

   Helpful Links:

   • Heroku Deployment
   • Heroku Postgres
   • Heroku Environment Variables
     
     
     

Installation

1. Install dependencies by running:

   npm install

2. Run the app with the commands:

   npm run server
   npm run client

(back to top)

Usage

You can create a user and login to the platform:

You can create login directly as a previous user:

Sidebar navigation of pages:

Create new report:

View public reports:

View details of public report:

View only current user reports:

Edit and delete of current user report:

Administrator user for toggling public/private reports:

SendGrid API for Administrator tracking new reports:

SendGrid API for Administrator tracking updated reports:

(back to top)

Roadmap

• Hand off to Dale for future development
• Dale inherits repo at current state
• Future Task #3
• Future Task #4
• Future Task #5

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make this community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Dale Lotts - LinkedIn

Project Link: PoliceConduct.org

(back to top)

Helpful

• README.md Composing
• Stack Overflow
• Material UI Documentation
• SendGrid API Documentation
• Flaticon

(back to top)

Acknowledgments

Creator:

• Dale Lotts

Developers:

• Frank Raso,
• Marc McCarthy
• Pete Hall and
• Robert Thao

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)