Integration Module 2.0 for Medusa is outRead the announcement
MeiliSearch logo

MeiliSearch

Enable fast search with MeiliSearch

npm install @vymalo/medusa-meilisearch
Category
Built by
Regions
Worldwide
Version
1.0.17
Last updated
1 year ago
Monthly downloads
Loading downloads

MedusaJS Meilisearch Integration

๐Ÿ” Powerful, lightning-fast search integration for MedusaJS using Meilisearch

๐ŸŒŸ Features

  • Instant, typo-tolerant search capabilities
  • Highly configurable indexing
  • Real-time search updates
  • Advanced filtering and ranking
  • Seamless MedusaJS integration

๐Ÿ—๏ธ Search Architecture

๐Ÿ“ฆ Installation

Install the package using npm:

Or using yarn:

๐Ÿš€ Configuration Types

Core Configuration Interface

Search Options

Configuration Breakdown

  • indexSettings: Allows provider-specific configuration

    • e.g., ,
    • Completely flexible key-value configuration
  • primaryKey:

    • Ensures unique documents in the index
    • Helps Meilisearch identify and manage documents
    • Recommended for data integrity
  • transformer:

    • Modify documents before indexing
    • Allows data cleaning, restructuring
    • Useful for complex data transformations

๐Ÿš€ Usage Example

๐Ÿ›ก๏ธ Key Capabilities

  • Flexible index configuration
  • Dynamic search filtering
  • Pagination support
  • Custom ranking and relevance
  • Multi-index management

๐ŸŒ Environment Variables

Required:

  • : Meilisearch server URL
  • : Meilisearch admin API key

๐Ÿš€ Performance Tips

  • Use appropriate index settings
  • Leverage filtering and faceting
  • Implement pagination
  • Monitor index size and query performance
  • Handle potential null/undefined values

๐Ÿค Contributing

Contributions welcome!

  • Improve transformation logic
  • Optimize indexing performance
  • Share search configuration patterns

๐Ÿ“„ License

Check the license