Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jk-oster/pa11y-php
A php wrapper for the accessibility testing tool pa11y
https://github.com/jk-oster/pa11y-php
accessibility pa11y reporting testing
Last synced: about 2 months ago
JSON representation
A php wrapper for the accessibility testing tool pa11y
- Host: GitHub
- URL: https://github.com/jk-oster/pa11y-php
- Owner: jk-oster
- License: mit
- Created: 2024-09-25T14:46:28.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T15:47:12.000Z (2 months ago)
- Last Synced: 2024-10-26T02:10:40.495Z (about 2 months ago)
- Topics: accessibility, pa11y, reporting, testing
- Language: PHP
- Homepage: https://jk-oster.github.io/pa11y-php/
- Size: 312 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# A package to create accessibility reports in php
[](https://packagist.org/packages/jk-oster/pa11y-php)
[](https://github.com/jk-oster/pa11y-php/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/jk-oster/pa11y-php/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/jk-oster/pa11y-php)
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
## Support us
[
](https://spatie.be/github-ad-click/pa11y-php)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require jk-oster/pa11y-php
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag="pa11y-php-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="pa11y-php-config"
```
This is the contents of the published config file:
```php
return [
];
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="pa11y-php-views"
```
## Usage
```php
$laravelPa11y = new JkOster\Pa11y();
echo $laravelPa11y->echoPhrase('Hello, JkOster!');
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Jakob Osterberger](https://github.com/jk-oster)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.