Skip to content

franklsm1/accessibility-checker

Repository files navigation

Website Accessibiliity Checker

A UI taking a url and producing accessibility results

Thanks to Andrew Pulley (@apulley) for the puppeteer / axe integration code

You can view the live application here

Steps to run app locally

  1. clone the repo:
  2. inside the cloned repo install the server and UI dependencies:
    • npm run installBoth
  3. build the client (UI) static files:
    • npm run build
  4. run the application locally:
    • npm start
  5. visit http://localhost:8087 to see the site running locally

Steps to run container locally (assuming docker is installed)

  1. Build the container
    • docker build -t accessibility-checker .
  2. Run the container
    • docker run --privileged -p 8087:8087 --name accessibility-checker -d accessibility-checker
  3. Visit http://localhost:8087 to view the app
Helpful Docker commands:
  • SSH into container: docker exec -it accessibility-checker bash
  • Stop container: docker stop accessibility-checker
  • Remove container: docker rm accessibility-checker
  • View container logs: docker logs accessibility-checker
  • Remove dangling images: docker image prune

App Screenshot

Example URL to analyze: https://dequeuniversity.com/demo/mars/ Example Accessiblitity Report

About

A UI taking a url and producing accessibility results

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published