README

此模块将 Typesense 搜索引擎与 Magento 集成，为您的客户提供更快、更准确的搜索结果。

演示

您可以看到 Typesense 用于自动完成搜索栏的演示，以及 Typesense 驱动的带筛选器的分类页面渲染。 https://typesense-demo.develodesign.co.uk/

安装

Composer 安装

您可以通过 Composer 安装此模块。在您的 Magento 2 根目录中运行以下命令

composer require develodesign/magento2-module-typesense

复制模块

或者，您可以将模块文件复制到您的 Magento 2 安装中的 app/code/Develo/Typesense 目录。

php bin/magento module:enable Develo_Typesense
php bin/magento module:enable Algolia_AlgoliaSearch
php bin/magento setup:upgrade
php bin/magento setup:di:compile
bin/magento setup:static-content:deploy

就这样！develodesign/magento2-module-typesense 模块现在已安装到您的 Magento 2 商店。

配置

系统 > 配置 > 通用 > Typesense 搜索

• "启用": 一个是/否字段，用于启用或禁用 Typesense 适配器。
• "云 ID": 一个文本字段，用于输入 Typesense 云 ID。
• "管理 API 密钥": 一个用于输入 Typesense 管理API密钥的秘密密钥。
• "搜索只读密钥": 一个用于输入 Typesense 搜索只读密钥的公开密钥。
• "节点": 一个文本字段，用于输入 Typesense 节点。
• "端口": 一个文本字段，用于输入 Typesense 端口号。
• "路径": 一个文本字段，用于输入 Typesense 路径。
• "协议": 一个下拉字段，用于选择通信协议。
• "索引方法": 一个下拉字段，用于选择数据应索引的位置。

这些选项允许用户配置 Typesense 适配器模块并根据他们的需求自定义其行为。

在启用 Typesense 模块后，如果用户对配置进行了任何更改，则模块需要删除并重建集合。因此，用户需要在进行任何配置更改后执行完整的 Magento 重索引。这是确保搜索结果准确和更新的重要事项。

请注意，用户还需要根据要求配置 Algolia 模块。然而，由于我们的模块作为适配器，因此不需要实时凭据。

Typesense 模块使用 Algolia 设置，因此用户应像平常一样配置 Algolia。重要的是要注意，如果您设置了一个维度，您必须在产品属性部分也设置它。

有关自定义 Algolia 模块的更多信息，请参阅以下链接

• 自定义自动完成菜单
• 自定义即时搜索页面
• 自定义自定义前端事件

当从 Algolia 迁移时，您需要从维度中删除 "价格" 并审查产品和分类的可搜索属性。Typesense 在查询时更加严格，如果属性不存在，它将抛出错误。

审查以下配置，并在适用时将可搜索设置为 "否"

设置 > Algolia > 产品 > 属性

调试配置

您可能会遇到以下错误

pesense-adapter.js:1 Uncaught (in promise) Error: 404 - 在模式中找不到名为 "path" 的字段。

这是因为您为产品设置了可搜索属性，而这个属性不存在，或者可能是一个不存在的维度属性。您应该从这些区域删除属性并再次尝试。

文档

有关Typesense的更多信息，请参阅他们的官方文档。

您还可以查看Algolia的Magento 2模块。

贡献者

如何贡献

欢迎所有贡献。如果您有任何建议或发现任何问题，请创建一个GitHub问题或分叉存储库并提交一个拉取请求。

以下是贡献方法

1. 分叉项目。
2. 创建您的功能分支（git checkout -b feature/AmazingFeature）。
3. 提交您的更改（git commit -m 'Add some AmazingFeature'）。
4. 将更改推送到分支（git push origin feature/AmazingFeature）。
5. 打开拉取请求。

致谢

Algolia，为创建出色的产品索引和搜索配置模块

• Algolia开源模块

由以下团队构建和维护