HMRC Frontend contains the code and documentation for patterns specifically designed for HMRC.
GOV.UK Frontend and the GOV.UK Design System contains the code and documentation for design patterns designed to be used by all government departments.
The two sets of code and documentation are separate but used together.
See HMRC Design Patterns for examples of what the design patterns look like and guidance on how to use them in your service.
To install more than one version of Node.js, it may be easier to use a node version manager like nvm or n.
Clone this repository and install its dependencies.
git clone https://github.com/hmrc/hmrc-frontend.git
cd hmrc-frontend
npm install- Run
npm start - Components are available at http://localhost:3000
npm install hmrc-frontend
For use in frontend microservices running on MDTP, please refer to the README in play-frontend-hmrc.
If you need a pattern that does not appear in the HMRC Design Patterns, you can contribute a new one.
If you would like to propose a feature or raise an issue with HMRC Frontend, create an issue.
You can also create a pull request to contribute to HMRC Frontend. See our contribution process and guidelines for HMRC Frontend before you create a pull request.
We use tools to ensure the style of our SCSS and JS is consistent. The code is checked when the tests
run on the build server. If you are contributing SCSS or JS you'll probably be running
the tests using npm test - this includes the code style checks.
To run the code style checks independently you can run npm run lint.
Automatic fixing is available for a number of the code style rules we apply. To let the tool
automatically fix the issues it can fix run npm run lint:fix - that will show you any remaining
issues after the tool has fixed what it can for you.
This code is open source software licensed under the Apache 2.0 License.