oslabs-beta / equa11y

A stream-lined command line tool for developers to easily run accessibility testing locally through axe-core and puppeteer.

equa11y

Welcome to equa11y, an easy to use command-line tool for accessiblity testing.

To start:

npx equa11y

For testing websites you must place 'http://' before you type in a url. Local files can also be tested! If your site requires a server, spin it up and navigate to your locahost. If not, you can simply type in an absolute path!

• mac ex: 'file:///Users/**/mySite.html'
• win ex: 'C:\Users**\mySite.html'

To quit at any point use 'ctrl + c'.

Contribute

Find us on GitHub

More Information

Find us on the web

Read about us on Medium

Authors

Heather Friedman | LinkedIn | GitHub

Tjolanda Sullivan | LinkedIn | GitHub

Taylor Riley Du | LinkedIn | GitHub

Will Hack | LinkedIn | GitHub

License

This project is licensed under MIT License.

equa11y's Issues

Axe-core trademark use

Thanks for using axe-core! Could you please ensure that you are adhering to the trademark policy? Axe-core is a trademark of Deque Systems. Here are some common tips that should help:

• Ensure that the language surrounding your reference to axe-core does not imply in any way that you own it or have any formal partnership with Deque without prior written permission.
• Include the following attribution notice: “Axe-core® is a trademark of Deque Systems, Inc. in the US and other countries.” Adding this to your readme is a common approach.
• Axe-core® is capitalized at the beginning of a sentence. When used within a sentence, axe-core® is lowercase. Don’t stress attempting to include the ® symbol everywhere you say axe-core. If you include it in a prominent place, in addition to the attribution notice above, you should be good.
• Do not mistake the broader axe® brand name for the axe-core® open source project.
• Don’t stress renaming your entire project. If you adhere to the above tips, you should be covered in most cases.

Please comply with this request in 30 days time and let us know when to expect to see the changes live.

Regards,
The team at Deque