Fork me on GitHub

How do I get started?

The quickest way to pick up the aXe, is by using the extensions, available for Chrome and Firefox. For developers, we recommend installing axe-core directly and using it in your projects.

aXe Browser Extensions

How easy is aXe to use?

To download the module, make sure you have Node.js installed and are sitting in the root directory of your project, and execute the following command:


npm install axe-core --save-dev

Then include the JavaScript file in your test fixtures:


<script src="node_modules/axe-core/axe.min.js"></script>

Finally, make calls to the accessibility checker function at the appropriate points in your functional tests:


axe.run(document, function (error, results) {
  ok(results.violations.length === 0, 'Should be no accessibility issues');
  // complete the async call
  ...
});

Want more?

If you want a more in-depth view of what aXe can do and how you can start performing automated accessibility tests today, check out our our recorded webinar Creating Accessible Web Applications with aXe.

aXe Repository

You can download the source code from our GitHub repository where you can also fork, customize, extend and contribute.