README

🔎 Are you a Magento engineer? Join our team and help us deliver the best search solution for Magento stores!

• Auto-completion menu: Offer End-Users immediate access to your whole catalog from the dropdown menu, whatever your number of categories or attributes.

• Instant search results page: Have your search results page, navigation and pagination updated in realtime, after each keystroke.

Official website: community.algolia.com/magento.

Note: if your store is running under Magento version 2, please check our Algolia for Magento 2 extension.

Algolia Search

Algolia is a search engine API as a service capable of delivering realtime results from the first keystroke.

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.

You can check out our live demo.

Documentation

Check out the Algolia Search for Magento 1 documentation.

Installation

Follow our getting started guide.

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.

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:

$ ./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.

phpMyAdmin

A phpMyAdmin instance is available from http://[docker ip]/phpmyadmin

Shell

You can execute a shell inside the container with the following command:

$ 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:

$ ./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:

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