https://github.com/alphagov/places-manager

"Find My Nearest" API and management tools on GOV.UK
https://github.com/alphagov/places-manager

container govuk

Last synced: about 2 months ago
JSON representation

"Find My Nearest" API and management tools on GOV.UK

• Host: GitHub
• URL: https://github.com/alphagov/places-manager
• Owner: alphagov
• License: mit
• Created: 2011-08-03T08:52:34.000Z (about 13 years ago)
• Default Branch: main
• Last Pushed: 2024-05-29T08:36:03.000Z (4 months ago)
• Last Synced: 2024-06-03T20:48:18.106Z (4 months ago)
• Topics: container, govuk
• Language: Ruby
• Homepage: https://docs.publishing.service.gov.uk/apps/imminence.html
• Size: 3.28 MB
• Stars: 12
• Watchers: 85
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Places Manager (formerly Imminence)

Places Manager manages sets of 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)

- **Data sets**: Services can have many data sets, 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 data set.

## Technical documentation

This is a Ruby on Rails app, and should follow [our Rails app conventions](https://docs.publishing.service.gov.uk/manual/conventions-for-rails-applications.html).

You can use the [GOV.UK Docker environment](https://github.com/alphagov/govuk-docker) to run the application and its tests with all the necessary dependencies. Follow [the usage instructions](https://github.com/alphagov/govuk-docker#usage) to get started.

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

### Running the test suite

```sh

bundle exec rake

```

## Licence

[MIT License](LICENCE)

### Further documentation

- [Adding a new service](docs/adding-a-new-service.md)