⚠️ Archived — No Longer Maintained

This repository is no longer maintained and has been archived. Please use magento/magento2 instead.

---

Overview

Provides Read API through gRPC to serve Catalog Search related requests

NOTE: existing implementation is a "transition" phase which utilizes Magento Monolith fulltextsearch index among with DB connection (to retrieve necessary data to build search response, e.g. attributes names for build layered navigation)

Installation

Search Service can be installed in 2 ways:

• Monolithic installation: just copy files to your Magento root folder. This is for development purposes only, do not use in production.
• Standalone installation: recommended approach, install Search Service as a standalone installation

Standalone Project Installation

1. Add Magento authentication keys to access the Magento Commerce repository

• with auth.json: copy the contents of auth.json.dist to new auth.json file and replace placeholders with your credentials
• with environment variable: specify environment variable COMPOSER_AUTH according to documentation

2. Run bash ./dev/tools/make_standalone_app.sh
3. Run composer install
4. Run bin/command storefront:search:init with all required arguments to provide connection to Magento DB/Elasticsearch.

GRPC up (local php)

1. Run bin/command storefront:grpc:init \\Magento\\SearchStorefrontApi\\Api\\SearchProxyServer
2. Run ./vendor/bin/grpc-server

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the OSL-3.0 License. See LICENSE for more information.