Case Explorer is a web interface and set of APIs for exploring data scraped from the Maryland Judiciary Case Search by Case Harvester. The aim is to make an intuitive, easy-to-use Excel-like interface for browsing and searching through MD case data. Case Explorer's frontend is built with React, while the backend can be run locally with Flask or deployed to AWS Amplify. REST and GraphQL APIs are available.
Case Explorer requires Node.js 10x, Python3.9+, and GNU Make. It is also recommend to use Virtualenv with Python to set up a local development environment.
If you are running Debian, you can install dependencies with the following:
$ sudo apt-get update && sudo apt-get install -y build-essential libpq-dev nodejs python3 python3-pip virtualenv python3-virtualenv
Create a file at server/app/.env with the information for connecting to the production and development case databases. You can connect to Open Justice Baltimore's case databases using the following:
SQLALCHEMY_DATABASE_URI_PRODUCTION=postgresql://case_explorer:[email protected]/mjcs
SQLALCHEMY_DATABASE_URI_DEVELOPMENT=postgresql://case_explorer:qntsu004A&[email protected]/mjcs
CASE_DETAILS_BUCKET=mjcs-case-details
To use the Search By BPD Officer feature, you'll also need to set BPDWATCH_DATABASE_URI to provide information for the BPD Watch database.
You can use the following commands to run a local version of Case Explorer for development or testing purposes:
- Create and/or activate your Python virtual environment
make install_dependenciesmake generate_api_specsmake start_backend- (in another terminal)
make start_frontend
API specs can be generated for both GraphQL and Swagger/OpenAPI using make generate_api_specs.
TODO
$ npm install -g @aws-amplify/cli
$ amplify configure
$ amplify init
$ make deploy
