Serves email alert signup pages on GOV.UK
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Email alert frontend

Purpose

Email Alert Frontend

A consistent frontend for displaying email alert signup pages.

Live examples

Nomenclature

  • Email Alert Signup: a page displaying the title of what the User is signing up to
  • Tags: A key and array value pair which when are used by the Email Alert API to forward the user onto the signup URL

Dependences

Running the application

  $ ./startup.sh

If you are using the GDS development virtual machine then the application will be available on the host at http://email-alert-frontend.dev.gov.uk/

Running the test suite

$ bundle exec rake

Content Item

The schema sets out the fields required for the Content Item. The only two fields required in the details hash are summary and tags:

"summary": "You'll get an email each time any information on this policy is published or updated.",
"tags": {
  "policy": [
    "employment"
  ]
}

Your email alert signup page can then be visited at http://email-alert-frontend.dev.gov.uk/#{base_path}

Licence

MIT License