eyeable / eye-able-oxid
Installs: 9 038
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 0
Type:oxideshop-module
Requires
- php: ^8.1
- symfony/filesystem: ^6.0
Requires (Dev)
- mikey179/vfsstream: ~1.6.8
- oxid-esales/oxideshop-ce: dev-b-7.0.x
- phpmd/phpmd: ^2.11
- phpstan/phpstan: ^1.9.14
- phpunit/phpunit: ^10.4
- squizlabs/php_codesniffer: 3.*
Conflicts
- oxid-esales/oxideshop-ce: <7.1
This package is auto-updated.
Last update: 2024-10-15 07:52:37 UTC
README
This is the Oxid Module for Eye-Able® Assist. Our assistance software gives your users an accessible and personalised view of your website content. Eye-Able® Assist helps to customise the website to the individual needs of visitors. In this way, the assistance software promotes digital participation and improves the user experience.
Eye-Able® Assist contais over 25 functions for your accessibility and can be DSGVO-compliant integrated into all HTML-based interfaces.
Important
In a Demo-mode Eye-Able® Assist can be used with a limited amount of functionalities. To get the full Eye-Able® Assist Software functionalities you need to purchase a license from us. The full license lets you customize Eye-Able® Assist so that it will fit to your corporate design. Also we highly recommend to contact us for individual customization of the Eye-Able® Assist Software so that it works well on your website. For more Information check out our Website or contact us under info@eye-able.com
website and contact us!
Eye-Able® Report
You will also get a preview of our Eye-Able Report software. By activating the module, you will receive a short test report every 7 days that shows you the number of accessibility deficiencies after WCAG 2.2 Level AA on your homepage. If you would like a detailed report for all your subpages, please contact us under info@eye-able.com
Configuration
As of Eye-Able® Assist version 3, no configuration is required but is still possible.
In the Administrator Panel, do not change the Eye-Able® report API URL and the Eye-Able® API key unless explicitly instructed to do so by Eye-Able®
Installation Process
Branch compatibility
- b-6.5.x branch is compatible with OXID eShop compilation b-6.5.x
- b-7.0.x branch is compatible with OXID eShop compilation b-7.0.x
- b-7.1.x branch is compatible with OXID eShop compilation b-7.1.x
Install via composer:
cd <shopRoot>
composer require eyeable/eye-able-oxid
Install for development purposes
- Clone the repository into a suitable directory of your oxid shop, e.g. dev-packages.
cd <shop installation path>
git clone https://github.com/Tobias-Eye-Able/eye-able-oxid-module.git dev-packages/EyeAbleAssist --branch=b-7.1.x
- Install Module from local path:
cd <shop installation path>
composer config repositories.eyeable/eye-able-oxid path dev-packages/EyeAbleAssist
composer require eyeable/eye-able-oxid:*
Running integration tests
vendor/bin/phpunit --bootstrap=/var/www/source/bootstrap.php --testsuite=Integration -c /var/www/vendor/eyeable/eye-able-oxid/tests/phpunit.xml
Running codeception tests
vendor/bin/codecept run --bootstrap=/var/www/source/bootstrap.php -c /var/www/vendor/eyeable/eye-able-oxid/tests/codeception.yml