👨🏻
View Demo
Explore the docs »
Report Bug
Request Feature
Table of Contents
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.
-
This project was tested using Chromium browsers.
-
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.
-
Setup a free or paid account on SendGrid API.
-
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
-
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:
- Install dependencies by running:
npm install
- Run the app with the commands:
npm run server npm run client
- 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).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Dale Lotts - LinkedIn
Project Link: PoliceConduct.org
Creator:
- Dale Lotts
Developers:
- Frank Raso,
- Marc McCarthy
- Pete Hall and
- Robert Thao
Distributed under the MIT License. See LICENSE.txt for more information.