Download the PHP package develodesign/magento2-module-typesense without Composer

On this page you can find all versions of the php package develodesign/magento2-module-typesense. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of develodesign/magento2-module-typesense

Informations about the package magento2-module-typesense

Magento 2 Typesense Search Integration Module

This module integrates the Typesense search engine with Magento, providing faster and more accurate search results for your customers.

Demo

You can see a demo of both Typesense used for the Autocomplete search bar and Typesense powered Category page rendering with filters. https://typesense-demo.develodesign.co.uk/

Installation

Composer Installation

You can install the module via Composer. Run the following command in your Magento 2 root directory:

Copying the Module

Alternatively, you can copy the module files to the app/code/Develo/Typesense directory in your Magento 2 installation.

That's it! The develodesign/magento2-module-typesense module is now installed on your Magento 2 store.

Configuration

System > Configuration > General > Typesense Search:

These options allow users to configure the Typesense adapter module and customize its behavior according to their needs.

After enabling the Typesense module, if a user makes any changes to the configuration, the module will need to drop and rebuild the collections. As a result, the user will need to perform a full Magento reindex after making any configuration changes. This is important to keep in mind to ensure that the search results are accurate and up-to-date.

Note that users also need to configure the Algolia module to fit you requirements. However, live credentials are not needed as our module acts as an adapter.

The Typesense module uses the Algolia settings, so users should configure Algolia as they normally would. It's important to note that if you set a facet, you must also set it in the product attribute section.

For more information on customizing the Algolia module, please refer to the following links:

When migrating from Algolia, you will need to remove "Price" from the facets and review the Product and Category searchable attributes. Typesense is much more strict when querying so if an attribute does not exist it will throw an error.

Review the following config and set searchable to "No" when applicable:

Settings > Algolia > Products > Attributes

Debugging config

You may get errors such as:

pesense-adapter.js:1 Uncaught (in promise) Error: 404 - Could not find a field named "path" in the schema.

This is because you either have a searchable attribute for products which does not exist, or perhaps a facet attribute which does not exist. You should remove the attribute from these areas and try again.

Documentation

For more information about Typesense, check out their official documentation.

You can also check out Algolia's Magento 2 module.

Contributors

Name Email Twitter
Luke Collymore [email protected] @lukecollymore
Nathan McBride [email protected] @brideoweb

How to Contribute

Contributions are always welcome. If you have any suggestions or find any issues, please create a GitHub issue or fork the repository and submit a pull request.

Here's how to contribute:

  1. Fork the project.
  2. Create your feature branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a pull request.

Acknowledgments

Algolia for creating a great product indexing and search configuration module

Built and Maintained by

Develo

All versions of magento2-module-typesense with dependencies

PHP Build Version
Package Version
Requires algolia/algoliasearch-magento-2 Version ^3.9
typesense/typesense-php Version ^4.8
php-http/curl-client Version ^2.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package develodesign/magento2-module-typesense contains the following files

Loading the files please wait ....