Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.96 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.96 KB
Raw

Algolia Search for Magento

Algolia Search is a hosted full-text, numerical, and faceted search engine 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 and algoliasearch-client-js.

See features and benefits of Algolia Search Extension for Magento.

Latest version Magento 1.6.2 Magento 1.7.1 Magento 1.8.1 Magento 1.9.2 PHP >= 5.4

Documentation

Check out our documentation on community.algolia.com/magento.

Demo

You can check out our live demo.

Auto-completion menu

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

demo

Instant search results page

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

demo

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 boot2docker to run docker containers.

Setup the docker instance

Just run the following script to setup a running Magento 1.9.1 instance with some sample data & the Algolia Search extension installed:

$ ./dev/restart.sh -a YourApplicationID \
               -k YourAdminAPIKey \
               -s YourSearchOnlyAPIKey \
               -p YourIndexPrefix \
               -b http://`boot2docker ip`/ # change that if you're not using boot2docker

Administration panel

Administration login is admin with password magentorocks1 and you can access it from http://[boot2docker ip]/admin.

Phpmyadmin

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

Shell

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

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

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