Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alphagov/govuk-frontend

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.
https://github.com/alphagov/govuk-frontend

govuk-design-system govuk-design-system-team govuk-frontend

Last synced: 10 days ago
JSON representation

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.

Awesome Lists containing this project

README 

        
GOV.UK Frontend ·

[![Build Status](https://github.com/alphagov/govuk-frontend/workflows/Tests/badge.svg)](https://github.com/alphagov/govuk-frontend/actions?query=workflow%3ATests+branch%3Amain)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

=====================



GOV.UK Frontend contains the code you need to start building a user interface

for government platforms and services.



See live examples of GOV.UK Frontend components, and guidance on when to use

them in your service, in the [GOV.UK Design

System](https://design-system.service.gov.uk/).



## Contact the team



GOV.UK Frontend is maintained by a team at Government Digital Service. If you want to know more about GOV.UK Frontend, please email the [Design System

team](mailto:[email protected]) or get in touch with them on [Slack](https://ukgovernmentdigital.slack.com/messages/govuk-design-system).



## Quick start



There are 2 ways to start using GOV.UK Frontend in your app:



- [using Node.js package manager

  (npm)](https://frontend.design-system.service.gov.uk/installing-with-npm/) (recommended)

- by [copying our CSS, JavaScript and asset

  files into your project](https://frontend.design-system.service.gov.uk/install-using-precompiled-files/)



Once installed, you will be able to use the code from the examples in the

[GOV.UK Design System](https://design-system.service.gov.uk/)

in your service.



You should also have a plan to [stay up to date with changes](https://frontend.design-system.service.gov.uk/staying-up-to-date/).



## Browser and assistive technology support



To help manage the ever-growing number of browser versions, we group browsers into 4 grades:



- **grade A** - Most recent stable versions of Chrome, Firefox, Edge, Samsung Internet and Safari

- **grade B** - All stable versions of Chrome, Firefox and Edge released in the last 6 months and the last 4 major stable releases of Safari which are not supported in Grade A

- **grade C** - [All browsers that support ``](https://caniuse.com/es6-module) (Chrome 61+, Edge 16-18, Edge 79+, Firefox 60+, Safari 11+)

- **grade X** - All other browsers (including IE11 and older)



> **Note: Only browsers in grades A, B and C will run our JavaScript enhancements. We will not support our JavaScript enhancements for older browsers in grade X.**



For more information see [our Browser Support documentation](/docs/contributing/browser-support.md).



GOV.UK Frontend also supports:



- [recommended assistive technologies](https://www.gov.uk/service-manual/technology/testing-with-assistive-technologies#which-assistive-technologies-to-test-with)

- your users overriding colours in Windows, Firefox and Chrome



## Accessibility



The GOV.UK Design System team works hard to ensure that GOV.UK Frontend is accessible.



Using Frontend will help your service meet [level AA of WCAG 2.2](https://www.gov.uk/service-manual/helping-people-to-use-your-service/understanding-wcag). But you must still [check that your service meets accessibility requirements](https://www.gov.uk/service-manual/helping-people-to-use-your-service/making-your-service-accessible-an-introduction), especially if you extend or modify components.



You should also use [the JavaScript from GOV.UK Frontend](https://frontend.design-system.service.gov.uk/importing-css-assets-and-javascript/#javascript) and read the [accessibility statement for the GOV.UK Design System](https://design-system.service.gov.uk/accessibility/).



## Known issues flagged by validators or automated testing tools



Check our [list of known issues that may be reported by HTML Validators or automated testing tools](https://github.com/orgs/alphagov/projects/37).



## Security



GDS is an advocate of responsible vulnerability disclosure. If you’ve found a vulnerability, we would like to know so we can fix it.



For full details on how to tell us about vulnerabilities, [see our security policy](https://github.com/alphagov/govuk-frontend/security/policy).



## Licence



Unless stated otherwise, the codebase is released under the MIT License. This

covers both the codebase and any sample code in the documentation. The

documentation is © Crown copyright and available under the terms of the

Open Government 3.0 licence.



## Contributing



[To learn how to help us build GOV.UK Frontend, see our contribution guidelines.](CONTRIBUTING.md)



The govuk-frontend repository is public and we welcome contributions from anyone.



Contributors to alphagov repositories are expected to follow the [Contributor Covenant Code of Conduct](https://github.com/alphagov/.github/blob/main/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct). Contributors working within government are also expected to follow the [Civil Service code](https://www.gov.uk/government/publications/civil-service-code/the-civil-service-code).



We're unable to monitor activity on this repository outside of our office hours (10am to 4pm, UK time). To get a faster response at other times, you can [report abuse or spam to GitHub](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam).