Skip to content

tataragne/algoliasearch-magento

 
 

Repository files navigation

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 Build Status PHP >= 5.3

Magento 1.6.2 Magento 1.7.1 Magento 1.8.1 Magento 1.9.2 Magento 1.9.3

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

Packages

No packages published

Languages

  • PHP 77.9%
  • JavaScript 8.0%
  • HTML 5.7%
  • CSS 5.3%
  • Shell 3.1%