Developing Arrest Explorer

Welcome to The Illinois Criminal Justice Information Authority (ICJIA) Arrest Explorer Developer Guide!

This guide is meant for developers and other curious citizens who are interested in technical details of the Arrest Explorer project.

Running locally

It is possible to install a copy of Arrest Explorer locally and to modify it. This is useful if you are interested in learning how to build a similar application. Please do note that releasing copies of Arrest Explorer is not permitted by the User Agreement, though using the code with other data and without the ICJIA logo is.

GUI and API

NOTE

Arrest Explorer uses Node, Github, Vue, and VuePress. These brief directions assume you have git and node installed.

To install and run arrest explorer locally follow these steps.

# clone source repo
git clone https://github.com/ICJIA/arrest-explorer.git

# change directory
cd arrest-explorer

# install node modules
npm install

# serve for development
npm run serve

# build for production
npm run build

Documentation

This documentation site is also available as an example.

# clone source repo
git clone https://github.com/ICJIA/arrest-explorer-docs.git

# change directory
cd arrest-explorer-docs

# install node modules
npm install

# serve for writing
npm run docs:dev

# build to static files
npm run docs:build

Notice of Federal Funding and Federal Disclaimer

This website is funded through a grant from the Bureau of Justice Statistics, Office of Justice Programs, U.S. Department of Justice. Neither the U.S. Department of Justice nor any of its components operate, control, are responsible for, or necessarily endorse, this website (including, without limitation, its content, technical infrastructure, and policies, and any services or tools provided).