Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/algolia/algoliasearch-magento
Algolia Search integration for Magento 1 - compatible with versions from 1.6.x to 1.9.x
https://github.com/algolia/algoliasearch-magento
algolia magento magento-algoliasearch magento-extension php search
Last synced: about 1 month ago
JSON representation
Algolia Search integration for Magento 1 - compatible with versions from 1.6.x to 1.9.x
- Host: GitHub
- URL: https://github.com/algolia/algoliasearch-magento
- Owner: algolia
- License: other
- Created: 2014-02-18T23:49:42.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-06-27T07:49:44.000Z (6 months ago)
- Last Synced: 2024-10-02T10:46:18.468Z (2 months ago)
- Topics: algolia, magento, magento-algoliasearch, magento-extension, php, search
- Language: PHP
- Homepage: https://www.algolia.com/doc/integration/magento-1/getting-started/quick-start/
- Size: 89.8 MB
- Stars: 164
- Watchers: 97
- Forks: 116
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-magento - Algolia Search for Magento 1.6+ - Official Algolia implementation for Magento 1 – provides instant and typo-tolerant search, multicategory auto-complete and layered navigation (faceting). (Modules)
README
Algolia Search for Magento 1.6+
==================
-------
## 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.
-------
🔎 **Need help?** Check out our [Troubleshooting Guide](https://www.algolia.com/doc/integration/magento-1/troubleshooting/data-indexes-queues/) and our [General FAQs](https://www.algolia.com/doc/integration/magento-1/troubleshooting/general-faq/).
-------
- **Autocompletion menu:** Offer End-Users immediate access to your whole catalog from the dropdown menu, whatever your number of categories or attributes.
- **Instantsearch results page:** Have your search results page, navigation and pagination updated in realtime, after each keystroke.
Official website: [https://www.algolia.com/solutions/magento/](https://www.algolia.com/solutions/magento/).
*Note: if your store is running under Magento version 2, please check our [Algolia for Magento 2 extension](https://github.com/algolia/algoliasearch-magento-2).*
Algolia Search
--------------
[Algolia](http://www.algolia.com) 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](https://github.com/algolia/algoliasearch-client-php), [autocomplete.js](https://github.com/algolia/autocomplete.js) and [instantsearch.js](https://github.com/algolia/instantsearch.js).
You can check out our [live demo](https://magento.algolia.com).
Documentation
--------------
Check out the [Algolia Search for Magento 1 documentation](https://www.algolia.com/doc/integration/magento-1/getting-started/quick-start/).
Installation
------------
Follow our [getting started guide](https://www.algolia.com/doc/integration/magento-1/getting-started/quick-start/).
Contribute to the Extension
------------
### 1. Docker (recommended)
The easiest way to setup your development environment is to use [Docker](https://www.docker.com/). If you're a Mac user, use [Docker for Mac](https://docs.docker.com/engine/installation/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:
```sh
$ ./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:
```sh
$ 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:
```sh
$ ./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](https://github.com/colinmollenhour/modman) (a module manager for Magento) by running the following commands:
```sh
$ 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:
- [General FAQs](https://www.algolia.com/doc/integration/magento-1/troubleshooting/general-faq/)
- [Troubleshooting Guide](https://www.algolia.com/doc/integration/magento-1/troubleshooting/data-indexes-queues/)
- [Indexing Queue](https://www.algolia.com/doc/integration/magento-1/how-it-works/indexing-queue/)
- [Frontend Custom Events](https://www.algolia.com/doc/integration/magento-1/customize/custom-front-end-events/)
- [Dispatched Backend Events](https://www.algolia.com/doc/integration/magento-1/customize/custom-back-end-events/)