Skip to content

scottish-government-design-system/prototype-templates

Repository files navigation

Scottish Government Design System templates for GOV.UK Prototype Kit

This plugin for the GOV.UK Prototype Kit lets you create prototypes using the Scottish Government Design System. It contains a set of common page templates and has the Scottish Government Design System as a dependency.

How to install the Scottish Government Design System Prototype Templates plugin

  1. follow the instructions on creating a new GOV.UK prototype
  2. open a terminal window within that folder and run the following command to install the plugin npm install @scottish-government-design-system/prototype-templates
  3. in the same terminal window then run the following command, to install the Scottish Government Design System dependency, npm install @scottish-government/design-system
  4. in your text editor create a settings.scss file in app/assets/sass and add $govuk-global-styles: false; to it to prevent GOV.UK Frontend styles overriding other styling that you have

Optionally uninstall the GOV.UK Frontend plugin

The Scottish Government Design System does not require the GOV.UK Design System code (GOV.UK Frontend) so you may wish to uninstall this to reduce the file size of your prototype.

  1. add "allowGovukFrontendUninstall": true to your prototype config file at app/config.json to unlock the option to uninstall the plugin
  2. in the browser, navigate to the 'Manage your prototype' section and go to 'Plugins'
  3. click on the uninstall button of the plugins you wish to remove

Alternative install using online code editors

If you are unable to install Node on your machine, it is possible to use the GOV.UK Prototype Kit with online code editors such as GitHub Codespaces.

  1. Sign up for a GitHub account if you don't have one
  2. Go to GitHub Codespaces
  3. Use the 'Blank' quick start template to create a new codespace
  4. Follow the installation instructions above to install the GOV.UK Prototype Kit and then the Scottish Government plugins

How to use the Scottish Government Design System Prototype Templates plugin

  1. in the browser, navigate to the 'Manage your prototype' section and go to 'Templates'
  2. create pages using the available templates

View more information on templates.

Feedback, help and support

If you need help or support you can e-mail us at [email protected]

About

A GOV.UK Prototype Kit plugin to build prototypes with the Scottish Government Design System

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •