A Web application entirely hosted on github that lets you run accessibility evaluation on multiple pages for a collection of sites. The accessibility issues are saved in this repository and can be browsed and manually annotated to facilitate accessibility assessments, reviews, reporting and continuous testing.
WCAG 2.1 A & AA issues are reported by Pa11y (and detected by HTML_CodeSniffer and axe-core engines).
Note that automated detection can only cover a minority of WCAG rules. The rest must be manually detected.
Additional information in the wiki
Report issues & suggest new features
- The same instance can manage multiple sites and multiple pages per site (see config file)
- Automatically detects, stores and reports some of WCAG A & AA issues with details about location & problem
- Ability to manually annotate the issues (assigning a role, complexity, resolution status and a comment)
- Manually add and manage other issues not detected automatically
- Re-run automated tests on the same pages & update issues without losing annotations
- Issues are grouped by rules for quick, high-level annotation
- Filter issues by level and resolution status
- Summary showing the number of issues per page and level
- Simple visual regression tests
- Rule tagging system to help you categorise issues
- Web app and all data are stored on github and run off github servers
- Detection using Pa11y with html_codesniffer & Axe-Core engines
- Vue.js interface with default Bulma styles
- Regression test using Pa11y & Blink-diff
- M further testing & debugging, interface improvements
- S documentation (how to add new project, etc.)
- C assist with report & assessment generation
See the full list of github tickets
Note that local and live evaluation affect the same list of issues in Webval.
- clone this repository (
git clone [email protected]:kingsdigitallab/webval.git) - change to that cloned folder (
cd webval) - install the necessary packages:
npm i pa11y blink-diff - if (3) fails, you may need to do this first:
- install nvm on your machine
- restart your terminal session
- install node.js and npm:
nvm i node
- create a new project in projects/projects.json if needed
(replace culturecase with the name of the project to test, and http://localhost:8000 with the root of the site running on your machine)
- Evaluate your local site:
git pull && node docs/evaluate.js culturecase http://localhost:8000 - check the script ends with a message like this:
Detected issues (before) 84 -> 82 (now) - Push evaluation back to git:
git commit -am "pa11y evaluation" && git push - Check the results and screenshots on the live Webval app