algolia/algoliasearch-magento

Algolia Search for Magento

Thursday, June 28, 2018
by maxiloc
Repository
70 Watchers
147 Stars
15,532 Installations

PHP
0 Dependents
0 Suggesters
104 Forks
35 Open issues
92 Versions
18 % Grown

The README.md

Algolia Search for Magento 1.6+

, _(*1)

, _(*2)

, _(*3)

End of Support

🚨 The Algolia Magento 1 extension has reached End of Life regarding support and maintenance. We do not commit to maintain and support the extension past FEB 2021. We encourage you to upgrade to Magento 2 as Magento 1 has already reached its end of life., _(*4)

🔎 Need help? Check out our Troubleshooting Guide and our General FAQs., _(*5)

Autocompletion menu: Offer End-Users immediate access to your whole catalog from the dropdown menu, whatever your number of categories or attributes., _(*6)
Instantsearch results page: Have your search results page, navigation and pagination updated in realtime, after each keystroke., _(*7)

Official website: https://www.algolia.com/solutions/magento/., _(*8)

Note: if your store is running under Magento version 2, please check our Algolia for Magento 2 extension., _(*9)

Algolia Search

Algolia is a search engine API as a service capable of delivering realtime results from the first keystroke., _(*10)

This extension replaces the default search of Magento with a typo-tolerant, fast & relevant search experience backed by Algolia. It's based on algoliasearch-client-php, autocomplete.js and instantsearch.js., _(*11)

You can check out our live demo., _(*12)

Documentation

Check out the Algolia Search for Magento 1 documentation., _(*13)

Installation

Follow our getting started guide., _(*14)

Contribute to the Extension

1. Docker (recommended)

The easiest way to setup your development environment is to use Docker. If you're a Mac user, use Docker for Mac to run Docker containers., _(*15)

Setup the Docker instance

Just run the following script to setup a running Magento 1.9.2 instance with some sample data & the Algolia Search extension installed:, _(*16)

$ ./dev/restart.sh -a YourApplicationID \
               -k YourAdminAPIKey \
               -s YourSearchOnlyAPIKey \
               -p YourIndexPrefix \
               -b http://`docker ip`/

Administration panel

Administration login is admin with password magentorocks1 and you can access it from http://[docker ip]/admin., _(*17)

phpMyAdmin

A phpMyAdmin instance is available from http://[docker ip]/phpmyadmin, _(*18)

Shell

You can execute a shell inside the container with the following command:, _(*19)

$ docker exec -i -t algoliasearch-magento /bin/bash

Run the tests

Just run the following script to create a Magento container and launch the tests directly:, _(*20)

$ ./dev/runTests.sh -a YourApplicationID \
               -k YourAdminAPIKey \
               -s YourSearchOnlyAPIKey \
               -p YourIndexPrefix \
               -b http://`docker ip`/

2. Modman

If you do not want to use docker. You can use modman (a module manager for Magento) by running the following commands:, _(*21)

$ cd /path/to/your/magento/directory
$ modman init
$ modman clone https://github.com/algolia/algoliasearch-magento.git

Need Help?

Here are some helpful documentation to help with your issue:, _(*22)

The Versions

28/06 2018

dev-develop

dev-develop https://github.com/algolia/algoliasearch-magento

Algolia Search for Magento

magento-module algoliasearch-magento