README.md

Police Scorecard API

This is the new home of the Police Scorecard API project.

Using our API

Our API is Fully Documented using Apiary. Currently, our API is only open for select non-commercial use. If you are interested in obtaining an API Key ( required for access ), please contact Peter Schmalfeldt.

Developer Overview

• Downloading API
• Getting Setup with Docker ( Recommended )
• Development Scripts
• Unit Testing and Code Coverage Reports
• Maintaining API
• Testing Endpoints with Postman
• Troubleshooting

Additional Setup without Docker

• Getting Setup without Docker
• Server Configuration
• MySQL Configuration
• Elasticsearch Configuration