https://github.com/mikaelvesavuori/a11ytester
Just a few scripts that run a set of accessibility testing tools on one or more provided URLs.
https://github.com/mikaelvesavuori/a11ytester
a11y a11y-testing accessibility bash test-scripts
Last synced: 4 months ago
JSON representation
Just a few scripts that run a set of accessibility testing tools on one or more provided URLs.
- Host: GitHub
- URL: https://github.com/mikaelvesavuori/a11ytester
- Owner: mikaelvesavuori
- License: mit
- Created: 2022-01-27T19:37:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-22T08:28:27.000Z (over 1 year ago)
- Last Synced: 2025-01-16T16:22:39.669Z (5 months ago)
- Topics: a11y, a11y-testing, accessibility, bash, test-scripts
- Language: Shell
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# a11ytester
Just a few scripts that run a set of accessibility testing tools on one or more provided URLs.
Runs:
- [Webhint](https://webhint.io)
- [Lighthouse](https://github.com/GoogleChrome/lighthouse)
- [Axe](https://github.com/dequelabs/axe-core)
- [pa11y](https://pa11y.org)
## Installation
_Note that this entirely assumes that you are running on a Linux or Mac operating system!_
For the scripts just clone, copy, or download `install.sh`, `test.sh` and `a11ytester.sh` to your machine.
The installation script will set up a [`.hintrc`](https://webhint.io/docs/user-guide/configuring-webhint/summary/) configuration file and check for the presence of the required tools. If they are not installed you will be asked if you want them to be globally installed with [npm](https://nodejs.org/en/knowledge/getting-started/npm/what-is-npm/) or [Homebrew](https://brew.sh).
## Configuration for multiple pages
If you want to test multiple pages you must first create a JSON file (`config.json`) that contains a list of URLs.
## Running `a11ytester`
### Single page
Run `bash a11ytester.sh https://mydomain.com` in the folder where you keep the script.
### Multiple pages
**Make sure you have a JSON file (`config.json`) that contains a list of URLs!**
Run `bash test.sh` in the folder where you keep the script.
## Also check out
For testing in your IDE, consider:
- [axe Accessibility Linter](https://marketplace.visualstudio.com/items?itemName=deque-systems.vscode-axe-linter)
- [webhint](https://marketplace.visualstudio.com/items?itemName=webhint.vscode-webhint)