Skip to main content

Application: imminence

“Find My Nearest” API and management tools on GOV.UK

GitHub
imminence
Ownership
#govuk-find-and-view-accessibility-team
Hosting
AWS, on the backend machine class
Rake tasks
Integration, Staging or ⚠️ Production ⚠️

README

Imminence manages sets of (somewhat) structured data for use elsewhere on GOV.UK. It’s primarily used for geographical data such as lists of registry offices, test centres, and the like.

The data is structured as a set of Services which represent a distinct type of location. A Service can then have many Data Sets which are in turn collections of Places. Only one Data Set will be “active” at any given time.

Each data set is uploaded as a CSV file. A cron job takes care of geocoding the places within it. It can then be manually inspected or exported as CSV, JSON or KML so it can be tested using a variety of other tools.

There is a simple JSON API for integrating the data with other applications.

Nomenclature

  • Services: Represent a distinct type of location (e.g. Register Offices)
  • Datasets: Services can have many datasets, which are collections of Places. Only one Data Set will be “active” at any given time.
  • Places: Geocoded data of individual locations which belong to a Dataset.

Technical documentation

This is a Ruby on Rails app, and should follow our Rails app conventions.

You can use the GOV.UK Docker environment to run the application and its tests with all the necessary dependencies. Follow the usage instructions to get started.

Use GOV.UK Docker to run any commands that follow.

Running the test suite

bundle exec rake

Licence

MIT License