Table of Contents
Code bytes measured as stored on Mac disk:
* PHP Controllers ~ 741 KB (17%)
* Blade Template Views HTML with some JS CSS ~ 668 KB (16%)
* Survloop-Generated PHP Eloquent Data Table Models ~ 340 KB (8%)
* Survloop-Generated PHP Laravel Database Migration & Seeders ~ 2.5 MB (59%), (*2)
<a href="https://packagist.org/packages/flexyourrights/openpolice-departments" target="_blank", (*3)
* Survloop-Generated PHP Police Departments & Oversight Seeders ~ 15.9 MB, (*4)
OpenPolice is an open-source, open data web app empowering citizens to prepare, file, and track reports of police conduct. The site helps users submit complaints or commendations to appropriate police oversight agencies. By allowing users to publish reports online, we aim to establish better public transparency and oversight of police activity in the U.S. OpenPolice extends Survloop, which runs atop Laravel., (*5)
This software began as an internal tool to design our database, then prototype survey generation. Then it was adapted to the Laravel framework, and has continued to grow towards a content-management system for data-focused websites., (*6)
The upcoming OpenPolice web app can be tested out here, feedback welcome via the end of the beta demo submission process: /file-your-police-complaint
The resulting database designed using the engine, as well as the branching tree which specifies the user's experience: /db/OP, /tree/complaint
Among other methods, the resulting data can also be provided as XML included an automatically generated schema: /complaint-xml-schema, /complaint-xml-example, /complaint-xml-all, (*7)
Full install instructions also describe how to set up a development environment using VirutalBox, Vargrant, and Laravel's Homestead. For these instructions, the new project directory is 'myopenpolice'., (*8)
Install Laravel, Survloop, & OpenPolice on Homestead
% composer create-project laravel/laravel myopenpolice "8.5.*"
% cd myopenpolice
Edit these lines of the environment file to connect the default MYSQL database:, (*9)
% nano .env
APP_NAME="My Open Police"
% php artisan key:generate
% php artisan cache:clear
% COMPOSER_MEMORY_LIMIT=-1 composer require laravel/ui paragonie/random_compat mpdf/mpdf rockhopsoft/survloop flexyourrights/openpolice
% php artisan ui vue --auth
% nano composer.json
Next, install Laravel's out-of-the-box user authentication tools, Survloop, and the OpenPolice.org software:
$ nano composer.json
From your Laravel installation's root directory, update `composer.json` to require and easily reference OpenPolice:
config/app.php is no longer needed, but this can be tried if later steps break., (*10)
$ nano config/app.php
'providers' => [
'aliases' => [
'OpenPolice' => 'FlexYourRights\OpenPolice\OpenPoliceFacade',
'Survloop' => 'RockHopSoft\Survloop\SurvloopFacade',
% chown -R www-data:33 storage database app/Models
If installing on a server, you might also need to fix some permissions before the following steps...
% php artisan config:cache
% php artisan route:cache
% php artisan view:cache
% echo "0" | php artisan vendor:publish --force
% composer dump-autoload
% curl http://myopenpolice.local/css-reload
Clear caches and publish the package migrations...
$ nano database/migrations/2014_10_12_100000_create_password_resets_table.php
$ sudo nano database/migrations/2019_08_19_000000_create_failed_jobs_table.php
With certain databases (like some managed by DigitalOcean), you may need to tweak the Laravel migration:
Add this line before the "Schema::create" line in each file:
\Illuminate\Support\Facades\DB::statement('SET SESSION sql_require_primary_key=0');
$ php artisan migrate
$ php artisan db:seed --class=OpenPoliceSeeder
$ php artisan db:seed --class=OpenPoliceDeptSeeder
$ php artisan db:seed --class=ZipCodeSeeder
$ php artisan db:seed --class=ZipCodeSeeder2
$ php artisan db:seed --class=ZipCodeSeeder3
$ php artisan db:seed --class=ZipCodeSeeder4
Then initialize the database:
Initialize OpenPolice Installation
Then browsing to the home page should prompt you to create the first admin user account:
If everything looks janky, then manually load the style sheets, etc:
After logging in as an admin, this link rebuilds many supporting files:
Once installed, documentation of this system's database design can be found at /dashboard/db/all . This system's user experience design for data entry can be found at /dashboard/tree/map?all=1&alt=1 or publicly visible links like those above., (*14)
Better documentation is juuust beginning to be created...
More on the Survloop level is also starting here:
Here's the TODO list for the next release (1.0). It's my first time building on Laravel, or GitHub. So sorry., (*17)
- [ ] Correct all issues needed for minimum viable product, and launch Open Police Complaints.
- [ ] Integrate options for MFA using Laravel-compatible package.
- [ ] Code commenting, learning and adopting more community norms.
- [ ] Add decent levels of unit testing. Hopefully improve the organization of objects/classes.
Please help educate me on best practices for sharing code in this community. Please report any issue you find in the issues page., (*18)
Reporting a Security Vulnerability
We want to ensure that Open Police Complaints is a secure HTTP open data platform for everyone. If you've discovered a security vulnerability in OpenPolice.org, we appreciate your help in disclosing it to us in a responsible manner., (*19)
Publicly disclosing a vulnerability can put the entire community at risk. If you've discovered a security concern, please email us at rockhoppers at runbox.com. We'll work with you to make sure that we understand the scope of the issue, and that we fully address your concern. We consider correspondence sent to rockhoppers at runbox.com our highest priority, and work to address any issues that arise as quickly as possible., (*20)
After a security vulnerability has been corrected, a release will be deployed as soon as possible., (*21)