Repository files navigation

Leading Developers Toward a Friendly, Accessible Web for All

This was inspired by another project --Koa11y.

While working on some a11y audits (many, really) over the years, I quickly began to yearn for a quick and / or dirty way to generate reports utilizing the veritalbe plethora of tools publicly available. In addition to justmaking the reports, I really wanted to be able to interact with themimmediately in a way that was meaningful.

✅ Generate accessibility reports utilizing@axe-core/cli.

✅ View accessibility reports which have been generated utilizing the@axe-core/cli tools.

✅ Generate.csv sitemaps, containing a list of all URL's associated with a domain, as determined by theXML sitemap.

• Script user journeys to confirm that they are accessible to all users
• Generate accessibility reports for a.csv file containing a list of URLs
• Automated visual regression testing on specific URLs or scripted user journeys

If you've worked with tools like@axe-core/cli, you will be all too familiar with the process of sifting through cryptic JSON reports in order to figure out what your scan turned up. In the distant future, humans will probably be equipped with some JSON parsing library, capable of reading these reports at a glance. Until such a time, I wanted to devise a way to display this information in human-digestable chunks 😆

If you're interested in getting started with this tool, there are a few things to keep in mind before proceeding.

First and foremost, functionality is limited. Right now, users can only output reports to a pre-determined location on the client's file system. This build should be consideredpre-alpha.

Let's get started by cloning the repo. Once you have done that, let's run:

npm install

This will install our required dependencies -- the key piece being our@axe-core/cli! If you are interested in what else this project is built on, go ahead and take a glance at the package.json.

That's it! F*cking crazy, I know!

To get started, just run:

npm start

It's probable that you have enountered an issue where thechromedriver versions are mismatched. In these scenarios, perform a clean install of your node modules:

1. Delete yourpackage-lock.json
2. Re-install your node packages usingnpm install

This bug will be fixed at a later date.

Seeall known issues.

Wanna help out? Checkthis board out to see where you can get started!

MIT