Accessibility Checker is a web-based tool designed to help web developers and accessibility auditors in assessing the accessibility of websites. It leverages Puppeteer and axe-core to automate the detection of common accessibility issues, providing a quick and efficient means to ensure web content is accessible to all users, including those with disabilities. This tool is particularly useful for ensuring compliance with Web Content Accessibility Guidelines (WCAG).
These instructions will guide you on how to set up and run the Accessibility Checker on your local machine for development and testing purposes.
Before you begin, ensure you have the following installed:
- Node.js (Download from Node.js website)
- npm (Comes with Node.js)
First, clone the repository to your local machine:
git clone https://github.com/mobilerast/accessibility-checker.git
cd accessibility-checkerThen, install the necessary dependencies:
npm installTo run the Accessibility Checker, execute the following command in the root directory of the project:
node server.jsOpen a browser and navigate to http://localhost:3001. Enter the URL of the website you want to check in the input field and click the "Check Accessibility" button. The results will be displayed in an HTML table format.
- The project includes a
style.cssfile for basic styling. - The footer of the UI contains links to Rast Mobile's website and social media accounts.
- You can modify
style.cssand the HTML files to customize the UI according to your branding and design preferences.
Contributions to the Accessibility Checker are welcome. Please fork the repository and submit a pull request with your changes. For major changes, please open an issue first to discuss what you would like to change.
This project is licensed under the ISC License - see the LICENSE file for details.
For any queries, please reach out to Rast Mobile at mobilerast@gmail.com.
- Puppeteer (https://pptr.dev/)
- axe-core (https://www.deque.com/axe/)