A11yProbe

A11yProbe is a tool that helps you run automated accessibility tests on your website and displays a report of any issues found. The tool uses testing library that supports the Web Content Accessibility Guidelines (WCAG) 2.1.

Table of Contents

• Installation
• Usage
• Contributing
• License

Installation

You can install A11yProbe using npm:

$ npm install a11yprobe

Usage

To use A11yProbe, create a a11yprobe.json file in the root of your project, fill the URL of your application:

{
  "url": "http://localhost:3000"
}

NB: Change 3000 to the port your app is currently running.

Open another terminal (while your app is running), then run

$ npx a11yprobe

Contributing

Thank you for considering contributing to this project! We welcome any contributions, including bug fixes, new features, and documentation improvements.

See Contributor's guide

License

This project is licensed under the MIT - see the LICENSE file for details.