A responsive web app for the archive of the most serious allegations of misconduct brought against the Chicago Police Department and its employees as handled by the Chicago Police Board.
Dependencies
- Ruby 3.0.*
- Bundler
- Rails 6.1.*
- PostgreSQL (11+)
From wherever you'd like the policeboard folder to be created, run:
git clone https://github.com/ChicagoJusticeProject/policeboard.git
Create a file named .env in the root, with the contents below.
RACK_ENV=development
PORT=3000
For the first time, make sure Postgres is running, then execute:
bundle install
rake db:create db:migrate
rake db:seed
rake import:all
rails server
For subsequent times, still with Postgres running first, just run foreman start. Occassionally you may need to preface that with:
bundle install if new gems (modules/plugins) are used in the app, or rake db:migrate if the database schema has changed, or rake import:all if raw input data has changed.
Note this data is obtained from excel spreadsheets included in the repo, and may vary from production. Also note that the "rake db:seed" command creates a test user that you can use to log into the administrative side of the application when you run it locally. The username is "test@test.com" and password is "password".
As part of changes to bring in rich text fields, the entire code based has been upgraded and now uses
Webpacker. On first install you may need to run webpacker's compile command using bundle exec rake webpacker:compile. You may
also need to run this if you make updates to any Javascript files.
If running the app using Ubuntu or Windows Subsystem for Linux (WSL), you may come across an error similar to this when trying to access the app on your browser:
could not connect to server: No such file or directory Is the server running locally and accepting connections on Unix domain socket "/var/run/postgresql/.s.PGSQL.5432"?
To fix this, try adding host: localhost to the default settings section in the database.yml file.
The app runs on AWS Elastic Beanstalk. The database lives on Amazon RDS.
AWS Code Pipeline is configured to build from the staging branch of the Github repo. This should happen automatically whenever new code is committed. If it doesn't, you may need to log into AWS. If you need credentials, ask a CJP administrator.
Once the code has been vetted in staging, it should be merged into the master branch. Automatic deployments are not running on master at this time, but you can deploy the staging code into production from the Elastic Beanstalk admin interface.
Some images are stored in AWS S3, while others are stored in the assets folder. The image uploading process for AWS is managed by CarrierWave. For images handled by S3, if the image does not exist, it will display a fallback image.
CarrierWave automatically intercepts any requests for an S3 sourced image to the /uploads path. If S3 is configured as it is in staging and production, the path will automatically be transposed to the S3 path. S3 files should be configured for public read access.
The repo should now properly support the use of Gitpod.io. To use gitpod, fork the CJP repo, and then follow the instructions at the Gitpod.io site: https://www.gitpod.io/docs/getting-started/
Gitpod will spin up with a Postgres environment and should initialize everything for you. When it's running there will be three console windows opened up. The first installs the rails environment (bundle, etc). The second will initialize the database with test data. The third builds the webpack for the site. Just let everything run and eventually the terminal windows will close down to the last one.
The only step you'll need to take after launch is to start the rails server. At that point, it should be running. You might get a warning about popups, but otherwise you should see the site open in your browser once that starts up. The site can take a little time to launch the first time, but then you should be good to go.