Skip to content

alphagov/short-url-manager

Folders and files

NameName
Last commit message
Last commit date
Jul 19, 2024
Oct 19, 2023
Feb 23, 2024
Jan 29, 2025
Feb 21, 2025
Nov 10, 2020
Nov 19, 2024
Jul 8, 2014
Jan 29, 2025
Feb 23, 2024
Jan 31, 2024
Jan 23, 2024
Sep 24, 2024
Jul 8, 2014
Nov 9, 2021
Dec 10, 2024
Oct 19, 2023
Dec 10, 2024
Jan 29, 2025
Feb 25, 2025
Apr 12, 2016
Mar 12, 2020
Nov 30, 2021
Sep 21, 2020
Sep 30, 2021
Feb 20, 2025
Feb 20, 2025

Repository files navigation

Short URL manager

Publishing tool to request, approve and create Short URLs on GOV.UK. Short URLs are a short and easy-to-type URL that redirects to a piece of content at a much longer URL.

They are often used on posters, in leaflets or over the phone, so they are easy to use. For example:

/dwp/cps5

to

/government/publications/your-state-pension-estimate-explained-cps5

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.

Testing

The default rake task runs all the tests:

bundle exec rake

Permissions

Users must be given Signon permissions to access and use the features of this tool. The available permissions are:

  • request_short_urls: Can complete a form to request a new Short URL, which must be approved before being made
  • manage_short_urls: Can approve requests for Short URLs, and create the redirects on GOV.UK
  • receive_notifications: Will receive email notifications when a new short URL is requested.
  • advanced_options: Can create and approve requests using advanced options (prefix type redirects, and non-default segments mode values).

Licence

MIT License