Algolia
Provide powerful indexing and searching features in your commerce application with Algolia.
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
How to Install
1. Run the following command in the directory of the Medusa backend:
1npm install medusa-plugin-algolia
2. Set the following environment variables in Copy to clipboard
.env
:12ALGOLIA_APP_ID=<YOUR_APP_ID>ALGOLIA_ADMIN_API_KEY=<YOUR_ADMIN_API_KEY>
3. In Copy to clipboard
medusa-config.js
add the following at the end of the Copy to clipboardplugins
array:12345678910111213141516171819202122232425262728293031323334const 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",],},transform: (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:
1npm run start
2. Try searching products either using your storefront or using the Store APIs.