{"id":24731496,"url":"https://github.com/shayanabbas/accessibility-enhancer","last_synced_at":"2026-04-07T22:32:31.152Z","repository":{"id":270080866,"uuid":"907593242","full_name":"shayanabbas/accessibility-enhancer","owner":"shayanabbas","description":"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.","archived":false,"fork":false,"pushed_at":"2025-01-08T07:28:42.000Z","size":859,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-22T15:49:20.327Z","etag":null,"topics":["accessibility","enhancer","wordpress","wordpress-plugin"],"latest_commit_sha":null,"homepage":"https://wordpress.org/plugins/accessibility-enhancer/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shayanabbas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-24T00:23:40.000Z","updated_at":"2025-01-08T07:20:27.000Z","dependencies_parsed_at":"2024-12-28T09:26:03.520Z","dependency_job_id":"0b1d0949-2161-4674-9dda-2b330a0b4fc1","html_url":"https://github.com/shayanabbas/accessibility-enhancer","commit_stats":null,"previous_names":["shayanabbas/accessibility-enhancer"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/shayanabbas/accessibility-enhancer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shayanabbas%2Faccessibility-enhancer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shayanabbas%2Faccessibility-enhancer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shayanabbas%2Faccessibility-enhancer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shayanabbas%2Faccessibility-enhancer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shayanabbas","download_url":"https://codeload.github.com/shayanabbas/accessibility-enhancer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shayanabbas%2Faccessibility-enhancer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31532327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"ssl_error","status_checked_at":"2026-04-07T16:28:06.951Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessibility","enhancer","wordpress","wordpress-plugin"],"created_at":"2025-01-27T16:50:41.829Z","updated_at":"2026-04-07T22:32:31.133Z","avatar_url":"https://github.com/shayanabbas.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Accessibility Enhancer\n\n![Build Status](https://img.shields.io/badge/build-passing-brightgreen) ![PHP](https://img.shields.io/badge/PHP-8.3-blue) ![Node.js](https://img.shields.io/badge/Node.js-16-brightgreen) ![License](https://img.shields.io/badge/license-GPL--3.0-blue)\n\nThe 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.\n\n[![Preview WP Plugin](https://img.shields.io/badge/Preview-plugin-blue?style=for-the-badge\u0026logo=wordpress)](https://playground.wordpress.net/#ewoiJHNjaGVtYSI6ICJodHRwczovL3BsYXlncm91bmQud29yZHByZXNzLm5ldC9ibHVlcHJpbnQtc2NoZW1hLmpzb24iLAoibG9naW4iOiB0cnVlLAoic2l0ZU9wdGlvbnMiOiB7CiJibG9nbmFtZSI6ICJBY2Nlc3NpYmlsaXR5IEVuaGFuY2VyIgp9LAoicGx1Z2lucyI6IFsKImFjY2Vzc2liaWxpdHktZW5oYW5jZXIiCl0sCiJzdGVwcyI6IFsKewoic3RlcCI6ICJpbXBvcnRXeHIiLAoiZmlsZSI6IHsKInJlc291cmNlIjogInVybCIsCiJ1cmwiOiAiaHR0cHM6Ly9naXN0LmdpdGh1YnVzZXJjb250ZW50LmNvbS9zaGF5YW5hYmJhcy8yOTU4ODE1MTM4MDc3MjA4MzZmNDgxNGMzMGU5NTUyNS9yYXcvNmViYmQwYTYyMWM3NjQwYTRlZjZlMDliYTA3MThhOGNkMzg0YTUzYy9leHBvcnQlMjUyMGNvbnRlbnQlMjUyMGR1bW1wLnhtbCIKfQp9Cl0KfQ==)\n\n---\n\n## Features\n\n- **Dynamic Toolbar**: Front-end accessibility toolbar with text resizing and contrast adjustment options.\n- **Automated Reports**: Generates accessibility reports for pages and posts.\n- **WCAG Compliance**: Includes tools to check for WCAG violations such as missing alt tags, improper heading structures, and insufficient contrast.\n- **REST API Integration**: Custom REST API endpoints for fetching and saving accessibility data.\n- **React Integration**: Modern front-end components built with React.js.\n\n---\n\n## Technology Stack\n\n- **WordPress**: Backend framework.\n- **PHP**: Core language for WordPress development (version 8.3 recommended).\n- **React.js**: Front-end library for the accessibility toolbar and admin dashboard.\n- **Webpack**: Module bundler for managing assets.\n- **Composer**: Dependency management for PHP.\n- **Babel**: JavaScript compiler for ES6+ features.\n- **DDEV**: Local development environment for WordPress.\n\n---\n\n## Requirements\n\n- **Docker** and **DDEV** installed on your system.\n- PHP version **8.3** or higher.\n- Node.js (version **16** recommended) and npm/yarn for JavaScript dependencies.\n- Composer for PHP dependency management.\n\n---\n\n## Installation\n\n1. **Clone the Repository**\n   ```bash\n   git clone https://github.com/shayanabbas/accessibility-enhancer.git\n   cd accessibility-enhancer\n   ```\n\n2. **Start DDEV**\n   ```bash\n   ddev start\n   ```\n\n3. **Download and Install WordPress**\n   Run the provided `setup.sh` script to download and configure WordPress.\n   ```bash\n   ./setup.sh\n   ```\n\n4. **Install Composer Dependencies**\n   ```bash\n   cd public/plugins/accessibility-enhancer\n   composer install\n   ```\n\n5. **Install Node.js Dependencies**\n   Navigate to the plugin directory and install JavaScript dependencies.\n   ```bash\n   cd public/plugins/accessibility-enhancer\n   npm install\n   ```\n\n6. **Build Assets**\n   Use Webpack to build the plugin's JavaScript and CSS files.\n   ```bash\n   npm run build\n   ```\n\n---\n\n## Running the Project\n\n1. **Access WordPress**\n   Visit your local DDEV environment:\n   [http://accessibility-enhancer.ddev.site](http://accessibility-enhancer.ddev.site)\n\n2. **Activate the Plugin**\n   - Log in to the WordPress admin panel.\n   - Navigate to `Plugins \u003e Installed Plugins`.\n   - Activate the \"Accessibility Enhancer\" plugin.\n\n---\n\n## Development\n\n1. **Frontend Development**\n   - Run the Webpack development server for hot-reloading.\n     ```bash\n     npm start\n     ```\n   - Access the React components in `src/components/`.\n\n2. **Backend Development**\n   - Add or modify PHP classes in the `includes/` directory.\n\n3. **REST API Development**\n   - API endpoints are located in `class-rest-api.php`.\n   - Test endpoints using tools like Postman or directly through the WordPress REST API console.\n\n---\n\n## Testing\n\n- **PHP Testing**\n  Run PHP CodeSniffer:\n  ```bash\n  composer phpcs\n  composer phpcbf # For auto fix\n  ```\n\n- **JavaScript Testing**\n  Lint JavaScript files:\n  ```bash\n  npm run lint\n  npm run lint:fix # For auto fix\n  ```\n\n---\n\n## Release\n\n- **Build Release**\n  Run the provided `release.sh` file that will build a release in `./build` folder.\n  ```bash\n  ./release.sh\n  # use `--no-zip` for not creating a zip file\n  ./release.sh --no-zip\n  ```\n\n---\n\n## Contribution\n\n- Fork the repository.\n- Create a feature branch:\n  ```bash\n  git checkout -b feature/\u003cfeature-name\u003e\n  ```\n- Submit a pull request with detailed descriptions of the changes.\n\n---\n\n## License\n\n![License](https://img.shields.io/badge/license-GPL--3.0-blue)\n\nThis project is licensed under the **GPL-3.0** license.\n\n---\n\nFor any issues or feature requests, please [open an issue](https://github.com/shayanabbas/accessibility-enhancer/issues).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshayanabbas%2Faccessibility-enhancer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshayanabbas%2Faccessibility-enhancer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshayanabbas%2Faccessibility-enhancer/lists"}