equal-access

Note: This tool release is currently beta. Some links may not resolve.

This Git repository hosts tools that are part of the IBM Equal Access Toolkit and supporting components.

Overview

This README covers topics for developers. For non-developer usage, see the following instruction for individual tools:

• accessibility-checker-extension for Chrome (also refer to Chrome extension): web browser extensions that adds automated accessibility checking capabilities to Chrome and other browser that support the Chromium web-extension API
• accessibility-checker-extension for Firefox (also refer to Firefox extension) : web browser extensions that adds automated accessibility checking capabilities to Firefox
• accessibility-checker (also refer to npm): automated accessibility testing for Node-based test environments
• karma-accessibility-checker (also refer to npm): automated accessibility testing for the Karma environment

What's in this repository?

Tools (description above):

• accessibility-checker-extension
• accessibility-checker
• karma-accessibility-checker

Components:

• accessibility-checker-engine: accessibility rules and evaluation engine used by the tools
• rule-server: deploys the rules and engine for usage by the tools

Prerequisites

• NodeJS with NPM.
• Git, if you want to clone the repository to your local environment

Clone Repository

$ git clone --branch=master https://github.com/IBMa/equal-access.git
$ cd accessibility-checker

or with SSH

$ git clone --branch=master [email protected]:IBMa/equal-access.git
$ cd accessibility-checker

If using ssh for clone make sure to follow steps at: Connecting to GitHub with SSH

Usage

You can build all the tools from root directory or build each individual tool separately.

Build all the tools from root directory

cd to equal-access if you are not already in the directory, then run:

$ npm install
$ npm run build

The following libraries or tools are built by running the above commands

• In the equal-access/accessibility-checker-engine/dist directory
  • ace-debug.js: uncompressed javascript to be used in a browser environment for development
  • ace.js: compressed javascript to be used in a browser environment for production
  • ace-node-debug.js: uncompressed javascript library to be used in a NodeJS environment for development
  • ace-node.js: compressed javascript library to be used in a NodeJS environment for production
• In the equal-access/accessibility-checker/package directory
  • java script source that can be installed or deployed as npm package that works with an HTML parsing engines such as Selenium, Puppeteer, or Zombie to allow developers to perform integrated accessibility testing within a continuous integration pipeline such as Travis CI. Please view more details.
• In the equal-access/karma-accessibility-checker/package directory
  • javascript source that can be used as a Karma plugin, see more details.

Build each individual tool separately

Please check README for each individual tool for its build instruction:

• accessibility-checker-engine
• accessibility-checker-extension
• accessibility-checker
• karma-accessibility-checker