https://github.com/magento/storefront-search-ce

https://github.com/magento/storefront-search-ce

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/magento/storefront-search-ce
• Owner: magento
• Created: 2020-10-13T17:48:44.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-04-02T01:26:11.000Z (over 3 years ago)
• Last Synced: 2023-03-14T07:15:23.086Z (over 1 year ago)
• Language: PHP
• Size: 2.13 MB
• Stars: 4
• Watchers: 6
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://getcomposer.org/doc/03-cli.md#composer-auth)

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](./CONTRIBUTING.md) for more information.

### Licensing

This project is licensed under the OSL-3.0 License. See [LICENSE](./LICENSE.md) for more information.