OrcaCollective / OpenOversight

Police oversight and accountability through public data 👮
https://spd.watch
GNU General Public License v3.0
11 stars 11 forks source link
flask hacktoberfest police-data python

Build Status Documentation Latest GHCR.io image version Latest GHCR.io image size

OpenOversight (Seattle Fork)

OpenOversight is a Lucy Parsons Labs project to improve law enforcement accountability through public and crowdsourced data. We maintain a database of officer demographic information and provide digital galleries of photographs. This is done to help people identify law enforcement officers for filing complaints and in order for the public to see work-related information about law enforcement officers that interact with the public.

This repository represents the Seattle fork of the original project. For more info, see the old README or the original repository

Development

To run the project locally:

  1. Install just
  2. Run just fresh-start to spin up the database and insert the initial data. This will create a local super-admin user for you with the following information:
    1. Username: admin
    2. Email: admin@admin.com
    3. Password: admin
  3. Visit http://localhost:3000!

To re-generate the poetry lock file (if you need to update dependencies in pyproject.toml):

  1. Run just lock
  2. Include the modified poetry.lock file in your commit

Deployment

Please see the DEPLOY.md file for deployment instructions.

The same just commands can be used to deploy production. The docker-compose-prod.yml file defines the minimum services for running in production. In order to use this file, set the IS_PROD environment variable to true. This will run all commands using the prod docker file.