Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shopsys/luigis-box
[READ-ONLY] Plugin for search and autocompletion via luigisbox.com for Shopsys Platform
https://github.com/shopsys/luigis-box
Last synced: 2 months ago
JSON representation
[READ-ONLY] Plugin for search and autocompletion via luigisbox.com for Shopsys Platform
- Host: GitHub
- URL: https://github.com/shopsys/luigis-box
- Owner: shopsys
- License: other
- Created: 2024-02-22T11:24:31.000Z (11 months ago)
- Default Branch: alpha
- Last Pushed: 2024-05-22T10:36:15.000Z (8 months ago)
- Last Synced: 2024-05-22T11:26:17.218Z (8 months ago)
- Language: PHP
- Size: 72.3 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Shopsys Luigi's Box
[](https://packagist.org/packages/shopsys/luigis-box)
This bundle for [Shopsys Platform](https://www.shopsys.com) adds advanced search using [Luigi's Box](https://luigisbox.com).
The bundle is dedicated for projects based on Shopsys Platform (i.e. created from [`shopsys/project-base`](https://github.com/shopsys/project-base)) exclusively.
This repository is maintained by [shopsys/shopsys] monorepo, information about changes is in [monorepo CHANGELOG.md](https://github.com/shopsys/shopsys/blob/master/CHANGELOG.md).
## Documentation
[Documentation](https://docs.shopsys.com/en/latest/integration/luigis-box/) 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](https://getcomposer.org/):
```
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": "", "2": "", ...}' // JSON object with domain id as key and tracker id as value
```
Add this data loader to your `config/packages/overblog_dataloader.yaml`:
```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`):
```yaml
- 'RecommendationQueryDecorator'
```
Add a recommendation type to your frontend API types folder (`config/graphql/types/Recommendation`):
```yaml
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](https://github.com/shopsys/shopsys/issues/new) and/or send [pull requests](https://github.com/shopsys/shopsys/compare),
please use the main [Shopsys repository](https://github.com/shopsys/shopsys).
Please check our [Contribution Guide](https://github.com/shopsys/shopsys/blob/master/CONTRIBUTING.md) before contributing.
## Support
What to do when you are in trouble or need some help?
The best way is to join our [Slack](https://join.slack.com/t/shopsysframework/shared_invite/zt-11wx9au4g-e5pXei73UJydHRQ7nVApAQ).
If you want to [report issues](https://github.com/shopsys/shopsys/issues/new), please use the main [Shopsys repository](https://github.com/shopsys/shopsys).
[shopsys/shopsys]: (https://github.com/shopsys/shopsys)