- npm
- NodeJS (6.10 or higher)
In order to use this sample project, you will need to clone the repository from GitHub. Once you've done that, in your terminal, navigate from the project root back to this example.
cd node/jest-react-testing-lib
Next, you'll need to install the dependencies for this project including axe DevTools Browser and the DevTools Reporter. They are already listed in package.json, but access to Deque's private registry is required to install them. To do so, follow this guide on the Deque documentation site. Once your access to Deque's private registry has been configured, dependencies for this project can be installed as normal through yarn or npm.
npm install
Use this command to run the example
npm test
The sample test file is held within the test directory. This file contains an example of how to set up the axe DevTools Browser and Reporter APIs, test for accessibility, and generate formatted results.
Once the sample project has been run, formatted results can be found in the a11y-results folder. The folder will contain the raw JSON results as well as the html, csv, and xml report formats. There will be one additional html file which is an executive summary report aggregating results from all scans into one page.
Behind the scenes, npm test runs this command defined in package.json
"scripts": {
"pretest": "rimraf ./a11y-results",
"test": "jest"
},The rimraf command will clear any saved results, so if you want to store previous runs you should remove this part of the run command. If you modify this project and want to publish your results in a different folder other than ./ally-results then you should update the dir here as well.