Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rockhopsoft committed Jan 28, 2021
1 parent ab1b460 commit a113361
Showing 1 changed file with 13 additions and 38 deletions.
51 changes: 13 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,31 +27,21 @@
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 <a href="https://github.com/rockhopsoft/survloop" target="_blank">Survloop</a>, which runs atop <a href="https://laravel.com/" target="_blank">Laravel</a>.

<a href="https://openpolice.org" target="_blank">OpenPolice.org</a><br />

<a href="https://openpolice.org" target="_blank">OpenPolice.org</a>
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.

The upcoming OpenPolice web app can be tested out here, feedback welcome via the end of the <b>beta demo</b> submission process:<br />
<a href="https://openpolice.org/file-your-police-complaint" target="_blank">/file-your-police-complaint</a><br />
The resulting database designed using the engine, as well as the branching tree which specifies the user's experience: <a href="https://openpolice.org/db/OP" target="_blank">/db/OP</a><br />
<a href="https://openpolice.org/tree/complaint" target="_blank">/tree/complaint</a><br />
Among other methods, the resulting data can also be provided as XML included an automatically generated schema, eg.<br />
<a href="https://openpolice.org/complaint-xml-schema" target="_blank">/complaint-xml-schema</a><br />
<a href="https://openpolice.org/complaint-xml-example" target="_blank">/complaint-xml-example</a><br />
<a href="https://openpolice.org/complaint-xml-all" target="_blank">/complaint-xml-all</a>
The upcoming OpenPolice web app can be tested out here, feedback welcome via the end of the <b>beta demo</b> submission process: <a href="https://openpolice.org/file-your-police-complaint" target="_blank">/file-your-police-complaint</a>
The resulting database designed using the engine, as well as the branching tree which specifies the user's experience: <a href="https://openpolice.org/db/OP" target="_blank">/db/OP</a>, <a href="https://openpolice.org/tree/complaint" target="_blank">/tree/complaint</a>
Among other methods, the resulting data can also be provided as XML included an automatically generated schema: <a href="https://openpolice.org/complaint-xml-schema" target="_blank">/complaint-xml-schema</a>, <a href="https://openpolice.org/complaint-xml-example" target="_blank">/complaint-xml-example</a>, <a href="https://openpolice.org/complaint-xml-all" target="_blank">/complaint-xml-all</a>


# <a name="requirements"></a>Requirements

* php: >=7.4
* <a href="https://packagist.org/packages/laravel/laravel" target="_blank"
>laravel/laravel</a>: 8.5.*
* <a href="https://packagist.org/packages/rockhopsoft/survloop" target="_blank"
>rockhopsoft/survloop</a>: >=0.3
* <a href="https://packagist.org/packages/flexyourrights/openpolice-departments" target="_blank"
>flexyourrights/openpolice-departments</a>: 0.*
* <a href="https://packagist.org/packages/flexyourrights/openpolice-website" target="_blank"
>flexyourrights/openpolice-website</a>: 0.*
* <a href="https://packagist.org/packages/laravel/laravel" target="_blank">laravel/laravel</a>: 8.5.*
* <a href="https://packagist.org/packages/rockhopsoft/survloop" target="_blank">rockhopsoft/survloop</a>: >=0.3
* <a href="https://packagist.org/packages/flexyourrights/openpolice-departments" target="_blank">flexyourrights/openpolice-departments</a>: >=0.*
* <a href="https://packagist.org/packages/flexyourrights/openpolice-website" target="_blank">flexyourrights/openpolice-website</a>: >=0.*

# <a name="getting-started"></a>Getting Started

Expand Down Expand Up @@ -165,29 +155,21 @@ $ php artisan db:seed --class=ZipCodeSeeder4

### Initialize OpenPolice Installation

Then browsing to the home page should prompt
you to create the first admin user account:

Then browsing to the home page should prompt you to create the first admin user account:
http://openpolice.local

If everything looks janky, then manually load the style sheets, etc:

http://openpolice.local/css-reload

After logging in as an admin, this link rebuilds many supporting files:

http://openpolice.local/dashboard/settings?refresh=2


# <a name="documentation"></a>Documentation

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.
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.

Better documentation is juuust beginning to be created...

<a href="https://openpolice.org/code-package-files-folders-and-classes" target="_blank">openpolice.org/code-package-files-folders-and-classes</a>

More on the Survloop level is also starting here:
Expand All @@ -207,19 +189,12 @@ Here's the TODO list for the next release (**1.0**). It's my first time building

# <a name="contribution-guidelines"></a>Contribution Guidelines

Please help educate me on best practices for sharing code in this community.
Please report any issue you find in the issues page.
Please help educate me on best practices for sharing code in this community. Please report any issue you find in the issues page.

# <a name="security-help"></a>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.
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.

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.
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.

After a security vulnerability has been corrected, a release will be deployed as soon as possible.

0 comments on commit a113361

Please sign in to comment.