pb-dashboard
The purpose of this repository is to provide access to the source code for a https://policekillings.grassrootslaw.org/.
The dashboard provides a realish-time view into police killings across the United States.
Our first iteration of the dashboard was scrappy. We used a mix of Google Forms, Google Sheets, and Tableau Public, to ship this first prototype here-> https://public.tableau.com/profile/kamran2555#!/vizhome/shared/937995TNC
This repo is a living version of the dashboard, as it evolves into an independent application of its own.
Play with our APIs
Play with our APIs by grabbing a Postman collection over @ https://www.getpostman.com/collections/06bd5fb5b8fb8d3e53de.
Developing
This application is built on the React application framework Next.js.
Pre-requisites
In order to use run this project locally, you will need to have node installed.
Installation
First install the project dependencies with:
npm i
Running Locally
Running the Development Server
To run, start the development server with the following command:
npm run dev
Run the Database (Optional)
This repo comes with a development MySQL database that runs in docker based on the latest production dump (in mysql/dump.sql). You can generally start the database and just leave it running in the background.
Note: You only need to do this if you want to test making changes to the database. Most of the time you can point to the hosted DB in AWS.
In order to run the DB locally, you will need docker installed.
npm run start-dev-db
Then run the dev server pointed at the local database:
npm run dev-with-db
If you need to refresh the database for any reason, stop and re-start it:
npm run stop-dev-db
npm run start-dev-db
Running in Production
To run in production, first build the production assets and then start the production server:
npm run build
npm run start