README

This bundle for Shopsys Platform adds advanced search using Luigi's Box. The bundle is dedicated for projects based on Shopsys Platform (i.e. created from shopsys/project-base) exclusively. This repository is maintained by shopsys/shopsys monorepo, information about changes is in monorepo CHANGELOG.md.

Documentation

Documentation can be found in Shopsys Platform Knowledge Base.

Installation

The plugin is a Symfony bundle and is installed in the same way:

Download

First, you download the package using Composer:

composer require shopsys/luigis-box

Configuration

Set these environment variables in your project:

LUIGIS_BOX_ENABLED_DOMAIN_IDS // comma separated list of domain ids e.g. '1,2'
LUIGIS_BOX_TRACKER_IDS_BY_DOMAIN_IDS='{"1": "<TRACKER_ID_FOR_DOMAIN_1>", "2": "<TRACKER_ID_FOR_DOMAIN_2>", ...}' // JSON object with domain id as key and tracker id as value

Add this data loader to your config/packages/overblog_dataloader.yaml:

luigisBoxBatchLoader:
    alias: 'luigis_box_batch_loader'
    batch_load_fn: "@Shopsys\\LuigisBoxBundle\\Model\\Batch\\LuigisBoxBatchLoader:loadByBatchData"

Add a recommendation query to your frontend API (Query.types.yaml):

- 'RecommendationQueryDecorator'

Add a recommendation type to your frontend API types folder (config/graphql/types/Recommendation):

RecommendationType:
    type: object
    inherits:
        - 'RecommendationTypeDecorator'

Contributing

Thank you for your contributions to Shopsys LuigisBox package. Together, we are making Shopsys Platform better.

This repository is READ-ONLY. If you want to report issues and/or send pull requests, please use the main Shopsys repository.

Please check our Contribution Guide before contributing.

Support

What to do when you are in trouble or need some help? The best way is to join our Slack.

If you want to report issues, please use the main Shopsys repository.

shopsys / luigis-box

Maintainers

Details