📦 EqualifyEverything / Sample-Scanner

📄 README.md · 18 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18# Axe Web Service for Equalify
This simple web service will run the axe-core cli, so you can view WCAG 2.1 compliance errors.

## Requirements
You must have [axe-core cli](https://www.npmjs.com/package/@axe-core/cli) and its dependencies running on your web server. PHP 7+ must also be installed.

## Setup on Linux
After you setup a LEMP web server..
1. [Install node and npm](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04).
2. [Install Selenium and dependencies](https://towardsdatascience.com/how-to-setup-selenium-on-a-linux-vm-cd19ee47d922) - note: when installing chromdriver, you'll need to install the [latest version](https://chromedriver.chromium.org/downloads)
3. [Install axe-cli](https://www.npmjs.com/package/@axe-core/cli).
4. Add [axe-equalify](https://github.com/bbertucc/axe-equalify) wherever you want to run the web service.
5. Run `[yourdomain]/?url=[yoururl]`, replacing `[yourdomain]` and `[yoururl]`. You should see an output of axe.

## Additional Notes
- axe-core kept saying that I had the wrong version of chromedriver installed. I had the correct version. I had to add the flag `--chromedriver-path /usr/local/bin/chromedriver` to the axe-core call.
- axe-core had an error related to the chromedriver sanbox settings. I had to add `--chrome-options="no-sandbox` to the axe-core call.