Application: locations-api

An interface between GOV.UK’s frontend applications and external APIs involved in location based services.

• GitHub: locations-api
• Ownership: #govuk-patterns-and-pages
• Category: APIs
• Links:
  • Sentry (error tracking)
  • App dashboard: request rates, errors, durations
  • Kibana App Logs (Production, last 3 hours)
  • Kibana Worker Logs (Production, last 3 hours)
  • Argo CD (locations-api)

README

Acts as an interface between GOV.UK’s frontend applications and external APIs involved in location based services (e.g. postcode lookups).

Technical documentation

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

Running the test suite

To run all tests and linters:

bundle exec rake

To run all tests:

bundle exec rake test

To run a single rspec file:

bundle exec rspec spec/my_spec.rb

To run all linters:

bundle exec rake lint

Further documentation

• How postcodes are added, cached and updated
• OS Places API

Licence

MIT LICENCE.