README

Compat module for Algolia Search on Magento 2 using Hyvä Themes. This requires:

A Hyvä Themes key
Access to Algolia
blackbird/external-ressource-loader to dynamically load all the Algolia ressources.

Setup

Get the package

Composer Package: composer require blackbird/module-hyva-algolia-search

Zip Package: Unzip the package in app/code/Blackbird/HyvaAlgoliaSearch, from the root of your Magento instance.

Install the module

Go to your Magento root directory and run the following magento command:

php bin/magento setup:upgrade

If you are in production mode, do not forget to recompile and redeploy the static resources, or use the --keep-generated option.

Once the module is installed, please check the app/etc/hyva-themes.json file.
Depending on how the module has been installed, the following line must be now present in the app/etc/hyva-themes.json file.

Installed using composer

{
  "extensions": [
    ...
    {
      "src": "vendor\/blackbird\/module-hyva-algolia-search\/src"
    },
    ...
  ]
}

Installed using a Zip package

{
  "extensions": [
    ...
    {
      "src": "app\/code\/Blackbird\/HyvaAlgoliaSearch\/src"
    },
    ...
  ]
}

If the line is missing (notably for Magento 2.4.7 and late patches of Magento 2.4.6), please run the following command as per official documentation and check that the new line appears:

bin/magento hyva:config:generate

What's included

This compat modules offers full Hyvä-compatibility for the following Algolia services:

Algolia Search
Algolia InstantSearch
Algolia Recommend
Algolia Autocomplete
Algolia Insights

Default styling is heavily inspired by the native theme of Hyvä Themes. Most style classes are used directly in the relevent templates or in the overridable tailwind-source.css file located in the view/frontend/tailwind/ directory. Compare and wishlist feature has been reported.

Known issues, limitations

As of now, the Ajax add to basket feature has been implemented within a limited scope. Simple products have the quick ATB option but configurable products are forwarded to the product page.
The native Hyvä Themes implementation of the option selection on a product tile has not been integrated yet.
Filters styling on a listing page are quite raw at the moment. This will be improved in the future

blackbird / module-hyva-algolia-search

Maintainers

Details