GOV.UK Component Guide
A living style guide and documentation for GOV.UK Components — A new approach to sharing UI patterns between applications without having to duplicate code.
It's still in it's early stages, many features are missing or incomplete, and documentation may not be 100% accurate.
It's a pretty standard Rails app, clone it,
$ PLEK_SERVICE_STATIC_URI=assets.digital.cabinet-office.gov.uk ./startup.sh
If running on a VM, then Rails needs to be bound to
0.0.0.0 rather than localhost so that it can be accessed outside of the VM. This is if using
startup.sh but if running
bundle exec rails s yourself you'll need to bind the port manually.
PLEK_SERVICE_STATIC_URI environment variable points to a public instance of alphagov/static - This is where the component documentation used to generate the dynamic parts of this guide is fetched from. Pointing at
different static hosts may show different components.
Running against local static
If you'd like to run the component guide against a different version of static, for example, where you've added, or made changes to, components, you'll need to run a copy of static locally.
To get a local copy of alphagov/static, follow the installation and local running instructions there, then run the component guide with this command:
$ PLEK_SERVICE_STATIC_URI=http://0.0.0.0:3013 ./startup.sh
The app is deployed to a Heroku instance and is continuously deployed, updating whenever
master changes and CI passes.
To access the Heroku admin, add yourself through the shared
firstname.lastname@example.org account, or ask a contributor to add you.
These are required when running a production environment
PLEK_SERVICE_STATIC_URI- as above.
GOVUK_APP_DOMAIN- set to