Home
Apps

Application: govuk-display-screen

Provides realtime GOV.UK content analytics for digital signage

GitHub: govuk-display-screen
Ownership: #govuk-insights-and-analytics
Category: Utilities
Links: Sentry (error tracking)

Manage repo

README

Screen to display live data from GOV.UK. It displays the number of GOV.UK users in last 30 mins, columns displaying the most recent searches on GOV.UK, the most popular pages and recently published content. Please note, the dashboard is intended as an internal tool only.

screenshot

https://govuk-display-screen-20e334eeb1ba.herokuapp.com/

Running locally

To run the server you will need to set up some ENV variables.

We are using the dotenv gem to load environment variables from a .env file into ENV in development. You will need to create a .env file following the template of the .env.example file, add it into .gitignore, and then add in the keys for the env vars which can be acquired from the 2nd line Heroku account. You can access this account by using the 2nd line credentials held in govuk-secrets.

Once you have them, you should be able to start the server by running:

ruby ./server.rb

You can now navigate to the dashboard in your browser: http://localhost:4567/.

Where is the data coming from?

In the past, the dashboard made use of the performance platform service for its data. This serivce is now defunct, so we have moved to use the GA4 Ruby client instead. This client allows us to access the number of active users and most popular content.

Custom search result pages

/corona and /brexit pages previously displayed live search results that matched coronavirus and brexit related terms. They were removed due to lack of use. Use this PR as an example if bespoke search result pages need to be created in future.

Licence

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.