Forest Preserve of Cook County Document Search

Search and management interface for spatial documents, built for the Forest Preserve of Cook County.

Developing

Development requires a local installation of Docker and Docker Compose.

Before you start, you'll need a local settings file for development. If you're on the Blackbox keyring for this repo, you can decrypt a canonical settings file that is encrypted and stored in the configs directory. See the Blackbox documentation for details on how to install and use Blackbox, and run this command to decrypt the settings file once you have Blackbox set up:

blackbox_cat configs/local_settings.dev.py.gpg > docsearch/local_settings.dev.py

If you're not on the keyring for this repo, copy and edit the example settings file:

cp docsearch/local_settings.example.py docsearch/local_settings.dev.py

Next, build containers:

docker-compose build

Run the app:

docker-compose up

The app will be available at http://localhost:8000. The database will be exposed on port 32001.

Create a superuser to view the application:

docker-compose run --rm app ./manage.py createsuperuser

Loading initial data

Initial data is available in a separate repo, document-search-data, that is kept private in order to respect the privacy of entities mentioned in the metadata. The repo is hosted on AWS CodeCommit in the Forest Preserves AWS account. Request access to the repo, or open an issue here to request assistance preparing your own metadata for an initial import.

For guidance on configuring your local environment to work with AWS CodeCommit, see the official AWS docs.

Once you have access to document-search-data, clone it and copy it to a subdirectory of this repo called data/:

cp -R ./document-search-data/ ./document-search/data/

Then, load initial data using GNU Make:

docker-compose -f docker-compose.yml -f data/docker-compose.yml run --rm app make all

To create the search index, start by bringing up Solr in one shell:

docker-compose up solr

Then, in another shell, run the rebuild_index command:

docker-compose run --rm app ./manage.py rebuild_index

Running tests

Run tests with Docker Compose:

docker-compose -f docker-compose.yml -f tests/docker-compose.yml run --rm app

Deployment

This repo is configured to deploy in the following ways:

environment	deploys on
staging	commit to master branch
production	tagged commit or release

In both cases, Travis CI will run tests before triggering a new deployment with AWS CodeDeploy.