https://github.com/shayanabbas/accessibility-enhancer
Accessibility Enhancer is a WordPress plugin that helps improve website accessibility by providing a dynamic toolbar, automated reports, and tools to address accessibility issues. Built to comply with WCAG standards, it ensures your site meets global accessibility guidelines.
https://github.com/shayanabbas/accessibility-enhancer
accessibility enhancer wordpress wordpress-plugin
Last synced: about 2 months ago
JSON representation
Accessibility Enhancer is a WordPress plugin that helps improve website accessibility by providing a dynamic toolbar, automated reports, and tools to address accessibility issues. Built to comply with WCAG standards, it ensures your site meets global accessibility guidelines.
- Host: GitHub
- URL: https://github.com/shayanabbas/accessibility-enhancer
- Owner: shayanabbas
- Created: 2024-12-24T00:23:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-08T07:28:42.000Z (over 1 year ago)
- Last Synced: 2025-03-22T15:49:20.327Z (about 1 year ago)
- Topics: accessibility, enhancer, wordpress, wordpress-plugin
- Language: PHP
- Homepage: https://wordpress.org/plugins/accessibility-enhancer/
- Size: 839 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Accessibility Enhancer
   
The Accessibility Enhancer is a WordPress plugin designed to improve website accessibility. It provides features such as a dynamic toolbar for text adjustments and contrast changes, automated accessibility reports for site admins, and front-end tools to identify and address accessibility issues. This plugin is built to adhere to WCAG standards, ensuring your website meets global accessibility guidelines.
[](https://playground.wordpress.net/#ewoiJHNjaGVtYSI6ICJodHRwczovL3BsYXlncm91bmQud29yZHByZXNzLm5ldC9ibHVlcHJpbnQtc2NoZW1hLmpzb24iLAoibG9naW4iOiB0cnVlLAoic2l0ZU9wdGlvbnMiOiB7CiJibG9nbmFtZSI6ICJBY2Nlc3NpYmlsaXR5IEVuaGFuY2VyIgp9LAoicGx1Z2lucyI6IFsKImFjY2Vzc2liaWxpdHktZW5oYW5jZXIiCl0sCiJzdGVwcyI6IFsKewoic3RlcCI6ICJpbXBvcnRXeHIiLAoiZmlsZSI6IHsKInJlc291cmNlIjogInVybCIsCiJ1cmwiOiAiaHR0cHM6Ly9naXN0LmdpdGh1YnVzZXJjb250ZW50LmNvbS9zaGF5YW5hYmJhcy8yOTU4ODE1MTM4MDc3MjA4MzZmNDgxNGMzMGU5NTUyNS9yYXcvNmViYmQwYTYyMWM3NjQwYTRlZjZlMDliYTA3MThhOGNkMzg0YTUzYy9leHBvcnQlMjUyMGNvbnRlbnQlMjUyMGR1bW1wLnhtbCIKfQp9Cl0KfQ==)
---
## Features
- **Dynamic Toolbar**: Front-end accessibility toolbar with text resizing and contrast adjustment options.
- **Automated Reports**: Generates accessibility reports for pages and posts.
- **WCAG Compliance**: Includes tools to check for WCAG violations such as missing alt tags, improper heading structures, and insufficient contrast.
- **REST API Integration**: Custom REST API endpoints for fetching and saving accessibility data.
- **React Integration**: Modern front-end components built with React.js.
---
## Technology Stack
- **WordPress**: Backend framework.
- **PHP**: Core language for WordPress development (version 8.3 recommended).
- **React.js**: Front-end library for the accessibility toolbar and admin dashboard.
- **Webpack**: Module bundler for managing assets.
- **Composer**: Dependency management for PHP.
- **Babel**: JavaScript compiler for ES6+ features.
- **DDEV**: Local development environment for WordPress.
---
## Requirements
- **Docker** and **DDEV** installed on your system.
- PHP version **8.3** or higher.
- Node.js (version **16** recommended) and npm/yarn for JavaScript dependencies.
- Composer for PHP dependency management.
---
## Installation
1. **Clone the Repository**
```bash
git clone https://github.com/shayanabbas/accessibility-enhancer.git
cd accessibility-enhancer
```
2. **Start DDEV**
```bash
ddev start
```
3. **Download and Install WordPress**
Run the provided `setup.sh` script to download and configure WordPress.
```bash
./setup.sh
```
4. **Install Composer Dependencies**
```bash
cd public/plugins/accessibility-enhancer
composer install
```
5. **Install Node.js Dependencies**
Navigate to the plugin directory and install JavaScript dependencies.
```bash
cd public/plugins/accessibility-enhancer
npm install
```
6. **Build Assets**
Use Webpack to build the plugin's JavaScript and CSS files.
```bash
npm run build
```
---
## Running the Project
1. **Access WordPress**
Visit your local DDEV environment:
[http://accessibility-enhancer.ddev.site](http://accessibility-enhancer.ddev.site)
2. **Activate the Plugin**
- Log in to the WordPress admin panel.
- Navigate to `Plugins > Installed Plugins`.
- Activate the "Accessibility Enhancer" plugin.
---
## Development
1. **Frontend Development**
- Run the Webpack development server for hot-reloading.
```bash
npm start
```
- Access the React components in `src/components/`.
2. **Backend Development**
- Add or modify PHP classes in the `includes/` directory.
3. **REST API Development**
- API endpoints are located in `class-rest-api.php`.
- Test endpoints using tools like Postman or directly through the WordPress REST API console.
---
## Testing
- **PHP Testing**
Run PHP CodeSniffer:
```bash
composer phpcs
composer phpcbf # For auto fix
```
- **JavaScript Testing**
Lint JavaScript files:
```bash
npm run lint
npm run lint:fix # For auto fix
```
---
## Release
- **Build Release**
Run the provided `release.sh` file that will build a release in `./build` folder.
```bash
./release.sh
# use `--no-zip` for not creating a zip file
./release.sh --no-zip
```
---
## Contribution
- Fork the repository.
- Create a feature branch:
```bash
git checkout -b feature/
```
- Submit a pull request with detailed descriptions of the changes.
---
## License
This project is licensed under the **GPL-3.0** license.
---
For any issues or feature requests, please [open an issue](https://github.com/shayanabbas/accessibility-enhancer/issues).