This applies to OSX, but should be similar with any other Unix variant.

Clone the repository:

git clone git@github.com:ministryofjustice/courtfinder-search.git

Next, create the environment and start it up:

virtualenv env --prompt=\(courtfinder-search\)

source env/bin/activate

Install python dependencies (ignore the warnings):

pip install -r requirements/local.txt

Install node packages:

npm install

Compile the static assets:

gulp

Setup postgres: create a user courtfinder with no password and create a database called courtfinder_search, which user courtfinder has owner rights.

Create the database and put sample data in it:

cd courtfinder
./manage.py runmigrations
./manage.py migrate
./manage.py populate-db

Start the server:

./courtfinder/manage.py runserver

Testing uses Django's standard unit testing library. In order to run the tests, use:

python courtfinder/manage.py test search

Code coverage is measured using 'coverage', speficied in the requirements file for the testing environment. In order to run coverage, use:

coverage run --source='.' manage.py test search staticpages courts

The line above runs the unit tests, so it can replace the first command mentioned above. The coverage report is then available by using:

coverage report -m

The application uses the following environment variables.

• FEEDBACK_EMAIL_SENDER: the from address of the feedback emails sent by the application
• FEEDBACK_EMAIL_RECEIVER: the email addresses of the recipients of the feedback emails (comma separated)
• SMTP_HOSTNAME
• SMTP_PASSWORD
• SMTP_PORT
• SMTP_USERNAME
• SENTRY_URL: for monitoring. See https://getsentry.com/
• S3_KEY, S3_BUCKET, S3_SECRET: the populate-db command above either reads the court data from local files or, if those variables are set, from an S3 bucket.