Skip to content
This repository has been archived by the owner on Oct 17, 2022. It is now read-only.

shyim/FroshAlgolia

Repository files navigation

Algolia plugin for Shopware

Join the chat at https://gitter.im/FriendsOfShopware/Lobby

This plugin integrates the high-performance search cluster Algolia in your Shopware system.

Algolia Search allows full-text searches over tons of records within microseconds. This ensures a great UX for your customers and high click-through rates on your search results.

See it in action

Blazing fast as-you-type auto-suggestion with keyboard navigation:

FroshAlgolia auto suggestion

Requirements

  • Shopware >= 5.5.0
  • PHP >= 7.1

Installation

  • Download latest release
  • Extract the zip file in shopware_folder/custom/plugins/

Pushing article data to Algolia index

To push your article data to the algolia index, run the following command:

  • Full index update: php bin/console algolia:sync

Multiple shops / Multilanguage shops

The Plugin creates one Algolia index for each of your active shops. So if you have two shops (e.g. German and English), those shops would generate two indices following this naming convention:

<prefix>-<shopId>.

The prefix can be defined in the plugin config, the shopId is added automatically.

Article attributes

By default all article attributes (default and plugin-added) are pushed to Algolia Index. You can block attributes from being transmitted by adding their names in the plugin configuration under Blocked article attributes. Add all attribute names here and delimit them with a colon.

Article properties and instant search faceting

All article properties are published to Algolia index by default. If an option is marked as filterable it will be automatically added to the filter-sidebar on the instant search page. If you don´t want that a filter is shown there, simply remove the filterable flag from the option and recompile your theme.

PHPUnit tests

This plugin uses PHPUnit for unit tests. You can find the unit tests in the directory Tests/Unit. To start a test simply run

phpunit

in the root directory of the plugin via CLI.

Glossary

  • SERP is the synonym for "search engine result page" and in this plugin context SERP means the full search page that a user can access by entering a search-term in the main search box and presses enter.
  • List means a list of products.
  • Auto-Suggest means the ability to suggest matching results below the search field as soon as the user starts typing.

Contributing

Feel free to fork and send pull requests!

Licence

This project uses the MIT License.

About

No description, website, or topics provided.

Resources

License

MIT, MIT licenses found

Licenses found

MIT
LICENCE.md
MIT
license.txt

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •