boxalino/rtux-integration-magento2

Boxalino Real Time User Experience (RTUX) Magento2 integration guidelines

Maintainers

Details

github.com/boxalino/rtux-integration-magento2

Homepage

Source

Issues

Installs: 39

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

Language:JavaScript

Type:magento2-module

4.0.0 2024-01-16 15:41 UTC

Requires

MIT 76d35bbb713f1c18ac9981a86b09de28d654ecc4

real-timeintegrationmagento2boxalinopersonalizationrtux

This package is auto-updated.

Last update: 2024-12-22 08:16:47 UTC

README

Introduction

This repository is provided as guidelines (tutorials) on how to integrate Boxalino Winning Interractions in Magento 2. The integration is managed by the client. Boxalino can provide further documentation and assistance upon request.

Included functionalities (with samples of templates):

  1. Search As you Type (Autocomplete Flyout) integration - Ajax (faster alternative to Server Side)
  2. Search result page with facets (refinement filters), pagination and sorting
  3. PDP product recommendations (upsell, crosssell, related, etc)
  4. Category Product-listing results (a.k.a. Navigation) with facets (refinement filters), pagination and sorting
  5. CMS elements pages/blocks
  6. Dynamic router (ex: for brand pages or landing pages)

If you are new to using Boxalino in a Magento 2 environment, please have first a look at our introduction documentation here

The repository is being updated with new guidelines & scenario. Check the wiki page for instructions https://github.com/boxalino/rtux-integration-magento2/wiki

We value your feedback and we welcome the community's pull/merge-requests. Thank you.

Integration

Boxalino provides several repositories you will need. This one plays the role of the initial environment you will extend with your team. You also need the data layer and the framework layer. The data layer repository manages the export of your data to Boxalino. The framework layout is built following Magento 2 practices and provides elements (blocks, observers, helpers, etc) which your integration plugin can re-use and which is maintained by Boxalino.

While the other repositories (data layer and framework layer) will be maintained by Boxalino, this repository will not, as it is your integration environment in which you will work and use what you need and extend what you want. Therefore, as this repository is provided as a guideline (tutorial), you will need to integrate it (which means replicate it) in a repository/moduled maintainted&developed by the client's team. For this reason, this repository is generally not subject to Boxalino maintenance on client setup.

This repository can be deployed for testing Boxalino features or in order to prepare your own integration. In order to deploy it as is in a local environment, check the Setup steps bellow.

This repository can also be deployed for checking out Boxalino features (as a demo). By requiring this repository, it will also install other dependencies. Please review the composer.json and follow-up with other dependencies deployments guidelines.

In order to create your own integration layer All At Once - please check the wiki on Initial Setup (All-At-Once).

In order to create your own integration layer - please start in the wiki.

In order to deploy it for local demo (without Boxalino assistance or a need to maintain the code in a client setup), check the Setup steps bellow.

Setup (for local/testing purposes)

ONLY FOLLOW THESE STEPS IF YOU ARE DEPLOYING A LOCAL DEMO, OTHERWISE, GO TO THE wiki.

  1. Add the plugin to your project via composer composer require boxalino/rtux-integration-magento2

  2. Activate the plugin (Magento2 command) php bin/magento module:enable BoxalinoClientProject_BoxalinoIntegration

  3. Flush cache (Magento2 command)/ run setup:upgrade / setup:di:compile depending on your environment php bin/magento cache:flush

  4. Import the content of the complete-guidelines JSONs in Boxalino Intelligence Admin; test, save & publish.

    • Layout Blocks (Boxalino Intelligence Admin >> Marketing >> Layout Blocks)
    • Template Resources (Boxalino Intelligence Admin >> Advanced >> Template Resources)
    • Narratives (Boxalino Intelligence Admin >> Marketing >> Narratives)

  5. Update the Boxalino Framework configurations

  6. Run the exporter (is declared as dependency via composer.json)
    php bin/magento indexer:reindex boxalino_exporter

Documentation

Documentation available in the Magento 2 Integration Introduction

More documentation is available on each dependency repository wiki page:

  1. exporter layer
  2. framework layer
  3. integration usecases
  4. API php wiki

Contact us!

If you have any question, just contact us at support@boxalino.com