https://github.com/nfreear/accessibility-ci-demo
Demonstration of integrating automated accessibility testing tools into a continuous integration/deployment (CI/CD) workflow.
https://github.com/nfreear/accessibility-ci-demo
accessibility axe ci ci-cd demo jest lighthouse-ci nodejs
Last synced: 2 months ago
JSON representation
Demonstration of integrating automated accessibility testing tools into a continuous integration/deployment (CI/CD) workflow.
- Host: GitHub
- URL: https://github.com/nfreear/accessibility-ci-demo
- Owner: nfreear
- Created: 2023-03-09T17:44:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-04T15:54:03.000Z (over 1 year ago)
- Last Synced: 2025-01-12T10:15:33.953Z (over 1 year ago)
- Topics: accessibility, axe, ci, ci-cd, demo, jest, lighthouse-ci, nodejs
- Language: JavaScript
- Homepage:
- Size: 710 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Accessibility CI demo
[![Node.js CI][ci-img]][ci] (_expected to fail!_)
This repository demonstrates integrating automated accessibility testing tools into a [continuous integration/deployment (CI/CD)][intro] workflow.
* [@nfreear/accessibility-ci-demo][demo1] (_this repo._)
* [@nfreear/accessibility-devops][demo2]
Specifically, it demonstrates the use of two separate tools:
* [jest-axe][] with [Jest][],
* @treosh's [lighthouse-ci-action][].
The repo contains example _fails_ and _passes_ [pages](./pages), and corresponding [unit tests](./__tests__).
## ⚠️✋ This project does not guarantee that what you build is accessible.
The GDS Accessibility team found that only [~30% of issues are found by automated testing][gds].
You'll also need to:
* test your interface with the [assistive technologies that real users use][at] (see also [WebAIM's survey results][survey]).
* include disabled people in user research.
## Usage
```
npm install
npm test
```
[gds]: https://accessibility.blog.gov.uk/2017/02/24/what-we-found-when-we-tested-tools-on-the-worlds-least-accessible-webpage
[at]: https://www.gov.uk/service-manual/technology/testing-with-assistive-technologies#when-to-test
[survey]: https://webaim.org/projects/screenreadersurvey10/#primary
[jest]: https://jestjs.io/
[jest-axe]: https://github.com/nickcolley/jest-axe
[lighthouse-ci-action]: https://github.com/treosh/lighthouse-ci-action
[intro]: https://github.com/GoogleChrome/lighthouse-ci/blob/main/docs/introduction-to-ci.md
"Introduction to Continuous Integration (Google)"
[demo1]: https://github.com/nfreear/accessibility-ci-demo
"#1 Demos use of 'jest-axe' and 'lighthouse-ci-action'"
[demo2]: https://github.com/nfreear/accessibility-devops
"#2 Demos use of 'pa11y-ci' and Cypress"
[ci]: https://github.com/nfreear/accessibility-ci-demo/actions/workflows/node.js.yml
[ci-img]: https://github.com/nfreear/accessibility-ci-demo/actions/workflows/node.js.yml/badge.svg