⚠ This repository has now been archived and replaced with the ONS Design System - https://github.com/ONSdigital/design-system

Prerequisites

• get familiar with Fractal http://fractal.build/guide
• nodejs
• Set up a new environment for this project with nodeenv
• Yarn npm install yarn --global
• Gulp yarn global add gulp-cli

Getting started

1. Install dependencies with yarn
2. Run with browsersync yarn start

Pull requests

1. Review pull request and comment as appropriate.
2. Approved pull requests should then be pulled by approver and a deploy run to update the published pattern library.

Deploy

Deployment is handled via CI to Netlify, each merge to master updates the documentation at: https://sdc-global-design-patterns.netlify.com/

CDN

• Merging to master also deploys the build to the CDN and uses the Pattern Library master commit short hash as a folder.
• To access the CDN resources use the master branch commit short hash as folder.
• CDN URLs are the following pattern (https://cdn.ons.gov.uk/sdc/[short hash]/css/styles.css).
• The short hash of master is viewable on the repository code page for the master branch or by using git log --pretty=format:"%h" --max-count=1 on the master branch in your CLI.

Releasing

Create a GitHib release with a Semantic version number.

When a new release is created that release version will then be available on the CDN e.g. https://cdn.ons.gov.uk/sdc/[short hash]/css/responsive.css will be available at https://cdn.ons.gov.uk/sdc/[release version]/css/responsive.css

Key files for use

Replace v1.5.0 for the current release version:

• https://cdn.ons.gov.uk/sdc/v1.5.0/css/responsive.css
• https://cdn.ons.gov.uk/sdc/v1.5.0/css/fixed.css
• https://cdn.ons.gov.uk/sdc/v1.5.0/scripts/bundle.min.js