Giter Club home page Giter Club logo

mobilerast / accessibility-checker Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 46 KB

A tool for assessing website accessibility, leveraging Puppeteer and axe-core. It automates the process of detecting common accessibility issues, providing a quick and efficient means to ensure web content is accessible to all users, including those with disabilities.

License: MIT License

JavaScript 31.59% HTML 47.94% CSS 20.47%
accessibility accessibility-analysis accessibility-automation accessibility-testing accessible javascript nodejs validation violations axe-core

accessibility-checker's Introduction

Accessibility Checker

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).

Getting Started

These instructions will guide you on how to set up and run the Accessibility Checker on your local machine for development and testing purposes.

Prerequisites

Before you begin, ensure you have the following installed:

Installing

First, clone the repository to your local machine:

git clone https://github.com/mobilerast/accessibility-checker.git
cd accessibility-checker

Then, install the necessary dependencies:

npm install

Usage

To run the Accessibility Checker, execute the following command in the root directory of the project:

node server.js

Open 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.

UI Customization

  • The project includes a style.css file for basic styling.
  • The footer of the UI contains links to Rast Mobile's website and social media accounts.
  • You can modify style.css and the HTML files to customize the UI according to your branding and design preferences.

Contributing

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.

License

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

Contact

For any queries, please reach out to Rast Mobile at [email protected].

Acknowledgments

accessibility-checker's People

Contributors

mobilerast avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.