GOV.UK Design System
One place for service teams to find styles, components and patterns for designing government services.
Fork repository (optional)
If you're an external contributor make sure to fork this project first
git clone email@example.com:alphagov/govuk-design-system.git # or clone your own fork cd govuk-design-system
Using nvm (optional)
If you work across multiple Node.js projects there's a good chance they require different Node.js and npm versions.
To enable this we use nvm (Node Version Manager) to switch between versions easily.
Install npm dependencies
Start a local server
This will build sources, serve pages and watch for changes.
npm run build
Run the Sass linter
We are using the sass-lint plugin to lint the Sass files in
source/stylesheets. You can run the linter from command line by running:
npm run lint
GOV.UK Frontend packages
When changes are pushed to GitHub Travis will:
- run the tests
- lint the Sass stylesheets in
- run the
npm run buildcommand to ensure that the site can be generated
If any of these fail, this will be reported in the GitHub status checks interface.