PHPackages                             setono/sylius-meilisearch-plugin - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. setono/sylius-meilisearch-plugin

ActiveSylius-plugin

setono/sylius-meilisearch-plugin
================================

Meilisearch integration for your Sylius store

36614[7 issues](https://github.com/Setono/sylius-meilisearch-plugin/issues)[2 PRs](https://github.com/Setono/sylius-meilisearch-plugin/pulls)PHPCI failing

Since Feb 11Pushed 11mo ago5 watchersCompare

[ Source](https://github.com/Setono/sylius-meilisearch-plugin)[ Packagist](https://packagist.org/packages/setono/sylius-meilisearch-plugin)[ RSS](/packages/setono-sylius-meilisearch-plugin/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (4)Used By (0)

Meilisearch Plugin for Sylius
=============================

[](#meilisearch-plugin-for-sylius)

[![Latest Version](https://camo.githubusercontent.com/eaa759fed4674ca6f1dc911e7ffbdb46c80c01431598e0c15f10957685c41768/68747470733a2f2f706f7365722e707567782e6f72672f7365746f6e6f2f73796c6975732d6d65696c697365617263682d706c7567696e2f762f737461626c65)](https://packagist.org/packages/setono/sylius-meilisearch-plugin)[![Software License](https://camo.githubusercontent.com/9bf05add4e22cbb98645ce289ba96e4a92b711bf1ce160af2c16bc3225d70a68/68747470733a2f2f706f7365722e707567782e6f72672f7365746f6e6f2f73796c6975732d6d65696c697365617263682d706c7567696e2f6c6963656e7365)](LICENSE)[![Build Status](https://github.com/Setono/sylius-meilisearch-plugin/workflows/build/badge.svg)](https://github.com/Setono/sylius-meilisearch-plugin/actions)[![Code Coverage](https://camo.githubusercontent.com/dc2c7b0f6626d990d0ba16e413fe9399449496f94e6159b3b8b2225d6b2a2cfe/68747470733a2f2f636f6465636f762e696f2f67682f5365746f6e6f2f73796c6975732d6d65696c697365617263682d706c7567696e2f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/Setono/sylius-meilisearch-plugin)

[Meilisearch](https://github.com/meilisearch/meilisearch) is an open-source search engine written in Rust, designed to create lightning-fast and hyper-relevant search experiences out of the box.

Installation
------------

[](#installation)

```
composer require setono/sylius-meilisearch-plugin
```

### Import configuration

[](#import-configuration)

```
# config/packages/setono_sylius_meilisearch.yaml
setono_sylius_meilisearch:
    indexes:
        products:
            document: 'Setono\SyliusMeilisearchPlugin\Document\Product'
            entities: [ 'App\Entity\Product\Product' ]
    search:
        index: products
```

In your `.env.local` add your parameters:

```
###> setono/sylius-meilisearch-plugin ###
MEILISEARCH_URL=http://localhost:7700
MEILISEARCH_MASTER_KEY=YOUR_MASTER_KEY
MEILISEARCH_SEARCH_KEY=YOUR_SEARCH_KEY
###< setono/sylius-meilisearch-plugin ###
```

### Import routing

[](#import-routing)

```
# config/routes/setono_sylius_meilisearch.yaml
setono_sylius_meilisearch:
    resource: "@SetonoSyliusMeilisearchPlugin/Resources/config/routes.yaml"
```

or if your app doesn't use locales:

```
# config/routes/setono_sylius_meilisearch.yaml
setono_sylius_meilisearch:
    resource: "@SetonoSyliusMeilisearchPlugin/Resources/config/routes_no_locale.yaml"
```

### Implement the `IndexableInterface` in your entities

[](#implement-the-indexableinterface-in-your-entities)

The entities you've configured for indexing has to implement the `Setono\SyliusMeilisearchPlugin\Model\IndexableInterface`.

In a typical Sylius application for the `Product` entity it could look like this:

```