Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.95 KB

README.md

File metadata and controls

39 lines (24 loc) · 1.95 KB
Raw

Build Status

accessibility-checker-infrastructure

An example project setup with accessibility checking in place.

How to view the examples locally

You can run the following commands to start / stop / update the example project.

  • make init - Update/install the node packages
  • make start - Start the example containers
  • make stop - Stop the example containers
  • make dev - Run the assets watcher
  • make build - Build the assets
  • make test - Run the accessibility tests (with docker and locally)

Accessibility tests

In this project the accessibility testing is setup in two ways:

  • With docker
  • Locally (not in a docker container)

Both test setups use cucumber as a test runner, puppeteer (chromium) is used to render the webpage and axe does the actual accessibility testing.

Choosing the testing setup

For your own project you can choose what fits best. If you're using docker to run your app then it is most recommended to use the docker approach. It uses a pre-build image with all tools included (more info).

When using docker you don't need to install the devDependency cucumber-puppeteer-axe. That is only needed when you want to test it using NPM locally

Deployment and testing

We are deploying and testing in the pipeline using Travis-CI. You can see results of the pipeline tests here.

Deployment of the example website is done to GitHub Pages

License

The MIT License (MIT). Please view the License File for more information.