Find Data

This repository contains the alpha-stage data discovery component of data.gov.uk.

Development

To just run on your machine with Sqlite3 and Sqlite

git clone git@github.com:datagovuk/find_data_alpha.git
cd find_data_alpha

# vagrant machine
vagrant up
vagrant ssh
sudo apt-get install -y python-pip python-virtualenv git-core

# Make and activate a virtualenv for Python 3
virtualenv --no-site-packages --distribute -p /usr/bin/python3.4 venv
. ~/venv/bin/activate

# Install dependencies
sudo apt-get update
sudo apt-get install -y python3-dev libpq-dev
cd /vagrant
pip install -r requirements.txt

# Create local_settings.py - see "Configuration" below
vim src/find_data/settings/local_settings.py

# Run
cd /vagrant/src
. ~/venv/bin/activate
export DJANGO_SETTINGS_MODULE="find_data.settings.dev"
./manage.py migrate
./manage.py runserver

Configuration

To successfully run the server, you will require a local_settings.py file that is stored in src/find_data/settings/local_settings.py. The file should have the following contents:

# Elastic search specific settings.
ES_HOSTS='http://127.0.0.1:9200'
ES_INDEX = 'data_discovery_dev'

Static assets (CSS, JS, images)

This application is built using govuk_elements and govuk_template.

Assets from those packages are already included in this repository. Additionally the SCSS in govuk_elements is precompiled and the resulting CSS is also included in the repository.

The reason assets are copied and pre-compiled here is to simplify deployments. That way, we're avoiding retrieving the govuk_ repositories, compiling the SASS (which would require installing nodejs and npm), concatenating and minifying.

As a consequence, if changes are made to the javascript or SCSS files, the developer will have to recompile locally. This will require installing nodejs and npm, and running the following steps:

> npm install
> gulp styles
> gulp javascripts

If a new version of the govuk packages is needed, you will have to copy and compile them again, and add the resulting files in this repository.

Acceptance testing

End-to-end tests can be found in the tests directory. They are run using nightwatch. To install nightwatch, use: npm install -g nightwatch.

The variables at the top of the Makefile should be set to suit your local environment.

Then you can just run make test to run the test suite.