Skip to main content

Application: contacts-admin

Publishes HMRC contact information on GOV.UK

Ownership
#govuk-platform-health
Hosting
AWS, on the backend machine class
Rake tasks
Integration, Staging or ⚠️ Production ⚠️

Imported documents

README

This app publishes contact information for a given organisation to GOV.UK. It replaces the HMRC contact us application and although it works for any organisation, only HMRC currently uses it.

Live examples

finder-frontend displays the index page for an organisation’s contacts:

government-frontend displays the contacts themselves, fetching them from content store:

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.

Before running the app

The best way to get a database with good seed data is to replicate from Integration. Alternatively, you can use a combination of import commands and old seed data to seed the database, as follows:

env GOVUK_APP_DOMAIN='https://www.gov.uk' GOVUK_WEBSITE_ROOT='https://www.gov.uk' bin/rake db:seed
bundle exec rake contacts:import_hmrc DATA_FILE=db/contact-records.csv

Contacts Admin imports from Whitehall’s organisations API (as the source of truth for organisations); and its world locations API (to provide the list of countries for the dropdown in the address form).

Running the test suite

bundle exec rspec

Further documentation

Check the docs/ directory.

Licence

MIT License