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

https://github.com/bbc/bbc-a11y

BBC Accessibility Guidelines Checker
https://github.com/bbc/bbc-a11y

Last synced: 9 months ago
JSON representation

BBC Accessibility Guidelines Checker

Awesome Lists containing this project

README

          

# BBC Accessibility Standards Checker

This tool runs a set of tests against a set of URLs to verify whether each one
meets the [BBC accessibility
guidelines](https://www.bbc.co.uk/accessibility/forproducts/guides/mobile/).

This project is a work in progress, but it is stable and you can use it to
test the accessibility of your website, or add use it in your web project
today.

[![NPM downloads](https://img.shields.io/npm/dm/bbc-a11y.svg?style=flat)](https://npmjs.org/package/bbc-a11y)
[![Build Status](https://github.com/bbc/bbc-a11y/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/bbc/bbc-a11y/actions/workflows/test.yml)

## Using BBC A11y to test web pages

There are a few different ways you might want to use bbc-a11y. Choose the guide
that best describes you:

* I am a manual tester or non-technical user and I want to
[use bbc-a11y to check a website](./guides/using/checking-a-website.md)

* I am a developer or tester and I want to
[add bbc-a11y to my web project or use advance features](./guides/using/using-bbc-a11y-in-your-project.md)

* I am a developer or tester and I want to
[use docker to run bbc-a11y within a CI environment](./docker/README.md)

## Contributing to BBC A11y

We welcome contributions of all shapes and sizes. If you want to help, please
refer to the guide that best describes you:

* I have a
[suggestion for how to improve bbc-a11y](./guides/contributing/suggesting-improvements.md)

* I would like to
[raise an issue with a bbc-a11y standards check](./guides/contributing/raising-issues-with-standards-checks.md)

* I would like to
[change the code](./guides/contributing/code-changes.md)

## Coverage

Not all of the standards are covered by automated checks. Some standards are
very difficult or impossible to cover with automated tests, others are partially
covered or work in progress, as [summarised here](./guides/coverage.md)

## License

bbc-a11y is available to everyone under the terms of the Apache 2.0 open source
licence. Take a look at the [LICENSE](./LICENSE) file in the code, and follow the links above to learn how to contribute.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright (c) 2017-present British Broadcasting Corporation