diff --git a/README.md b/README.md index c13a3ac..66163b6 100755 --- a/README.md +++ b/README.md @@ -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 Survloop, which runs atop Laravel. -OpenPolice.org
- +OpenPolice.org 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 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, eg.
-/complaint-xml-schema
-/complaint-xml-example
-/complaint-xml-all +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 # Requirements * php: >=7.4 -* laravel/laravel: 8.5.* -* rockhopsoft/survloop: >=0.3 -* flexyourrights/openpolice-departments: 0.* -* flexyourrights/openpolice-website: 0.* +* laravel/laravel: 8.5.* +* rockhopsoft/survloop: >=0.3 +* flexyourrights/openpolice-departments: >=0.* +* flexyourrights/openpolice-website: >=0.* # Getting Started @@ -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 # 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... - openpolice.org/code-package-files-folders-and-classes More on the Survloop level is also starting here: @@ -207,19 +189,12 @@ Here's the TODO list for the next release (**1.0**). It's my first time building # 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. # 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.