Algolia

Provide powerful indexing and searching features in your commerce application with Algolia.

Algolia Plugin Documentation | Medusa Website | Medusa Repository

Features

- Flexible configurations for specifying searchable and retrievable attributes.
- Ready-integration with Medusa's Next.js starter storefront.
- Utilize Algolia's powerful search functionalities including typo-tolerance, query suggestions, results ranking, and more.

---

Prerequisites

- Medusa backend
- Algolia account

---

How to Install

1\. Run the following command in the directory of the Medusa backend:

``bash
npm install medusa-plugin-algolia
`

2\. Set the following environment variables in .env:

`bash
ALGOLIA_APP_ID=
ALGOLIA_ADMIN_API_KEY=
`

3\. In medusa-config.js add the following at the end of the plugins array:

`js
const plugins = [
// ...
{
resolve: medusa-plugin-algolia,
options: {
applicationId: process.env.ALGOLIA_APP_ID,
adminApiKey: process.env.ALGOLIA_ADMIN_API_KEY,
settings: {
products: {
indexSettings: {
searchableAttributes: ["title", "description"],
attributesToRetrieve: [
"id",
"title",
"description",
"handle",
"thumbnail",
"variants",
"variant_sku",
"options",
"collection_title",
"collection_handle",
"images",
],
},
transformer: (product) => ({
id: product.id,
// other attributes...
}),
},
},
},
},
]
`

---

Test the Plugin

1\. Run the following command in the directory of the Medusa backend to run the backend:

`bash
npm run start
``

2\. Try searching products either using your storefront or using the Store APIs.

---

Additional Resources

- Algolia Plugin Documentation