Skip to main content

Application: datagovuk_find

Beta version of Find Data

README

Code Climate Test Coverage

This repository contains the beta-stage frontend component of data.gov.uk

How to run this repo locally

There are currently 3 ways to run this repo locally:

  1. Via govuk-dgu-charts - An end to end setup from ckan to opensearch to Find. This is the presently most supported means for running Find and is recommended for local development. Instructions for how to setup and run Find this way available on the linked repo.
  2. Manual installation. Instructions for this below.
  3. Via govuk-docker - You can make Find as you would any other repo supported by govuk-docker using this method. This is the quickest means to setup Find however this will not give you a complete visual setup and is primarily for running tests.

Manual installation

Prerequisites

You will need to install the following for development.

Most of these can be installed with Homebrew on a Mac.

Getting Started

First run bin/setup to bundle, etc. Then run rails s.

Deployment

Continuous Integration has been setup using Github Actions.

  • Tests are run on pull requests.
  • Deployments to Integration happen automatically when marging branches into the main branch.
  • In order to carry out a release to production a developer in the govuk team will need to create a release tag with a leading v and approve of the deployment in Github Actions.

Integration

To deploy to integration merge a PR into main.

Staging & Production

To deploy to staging/production you need to tag the release, the tag needs to be in this format - v9.9.9 where 9 is a number and the leading v is required. E.g. v0.1.11 is valid, 0.1.11 is not.

This will create a PR on govuk-dgu-charts which you should be able to approve and merge into main for testing.

Test that your changes are working in staging - https://staging.data.gov.uk before releasing to Production.

Then merge in the production release PR.

Example application URLs