README

Magento 2 modules for integrating BradSearch with your store's GraphQL layer.

Requirements

• Magento 2.4.x
• PHP 7.4, 8.1, 8.2, 8.3, or 8.4
• Composer 2.x

Installation

composer require bradsearch/magento-extension:^1.0
bin/magento module:enable BradSearch_Analytics BradSearch_Autocomplete BradSearch_ProductFeatures BradSearch_SearchGraphQl
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean

Configuration

Stores → Configuration → BradSearch in Magento Admin.

You'll need API credentials from your BradSearch account.

Extending

• Custom price logic for the bradProducts sync? Implement BradSearch\SearchGraphQl\Api\PriceCalculatorInterface in a bridge module inside your project. See SearchGraphQl/PRICE_CALCULATOR.md for the full walkthrough.

Updating

composer update bradsearch/magento-extension
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean

Uninstalling

bin/magento module:disable BradSearch_Analytics BradSearch_Autocomplete BradSearch_ProductFeatures BradSearch_SearchGraphQl
bin/magento setup:upgrade
composer remove bradsearch/magento-extension

Development

composer install              # installs captainhook pre-commit + pre-push hooks
composer phpcbf               # auto-fix Magento2 coding standard
composer phpcs                # Magento2 coding standard check
composer phpstan              # static analysis at level 6
composer psalm                # static analysis at error level 4
composer test                 # phpunit unit tests
composer check                # all of the above

Pre-commit hooks run phpcbf + phpcs + phpstan on staged PHP files. Pre-push runs psalm + full test suite. CI (GitHub Actions) runs the same checks across PHP 7.4 / 8.1 / 8.2 / 8.3 on every PR.

License

Apache License 2.0 - see LICENSE.