PHPackages                             boxalino/rtux-integration-magento2 - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. boxalino/rtux-integration-magento2

ActiveMagento2-module[API Development](/categories/api)

boxalino/rtux-integration-magento2
==================================

Boxalino Real Time User Experience (RTUX) Magento2 integration guidelines

5.0.0(1w ago)0401MITJavaScriptPHP &gt;=8.4

Since Jun 26Pushed 1w ago2 watchersCompare

[ Source](https://github.com/boxalino/rtux-integration-magento2)[ Packagist](https://packagist.org/packages/boxalino/rtux-integration-magento2)[ Docs](http://www.boxalino.com)[ RSS](/packages/boxalino-rtux-integration-magento2/feed)WikiDiscussions master Synced 6d ago

READMEChangelogDependencies (6)Versions (42)Used By (0)

Boxalino Real Time User Experience (RTUX) Integration - Magento2
================================================================

[](#boxalino-real-time-user-experience-rtux-integration---magento2)

Introduction
------------

[](#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](https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/392396801/Magento+2)*

The repository is being updated with new guidelines &amp; scenario. **Check the wiki page for instructions **

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

Integration
-----------

[](#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](https://github.com/boxalino/exporter-magento2) and the [framework layer](https://github.com/boxalino/rtux-magento2). 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&amp;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](https://github.com/boxalino/rtux-integration-magento2/blob/master/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)](https://github.com/boxalino/rtux-integration-magento2/wiki/Initial-Setup-(All-At-Once)).**

**In order to create your own integration layer - please start in the [wiki](https://github.com/boxalino/rtux-integration-magento2/wiki#before-you-start).**

**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)
----------------------------------

[](#setup-for-localtesting-purposes)

**ONLY FOLLOW THESE STEPS IF YOU ARE DEPLOYING A LOCAL DEMO, OTHERWISE, GO TO THE [wiki](https://github.com/boxalino/rtux-integration-magento2/wiki#before-you-start).**

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](https://github.com/boxalino/rtux-integration-magento2/wiki/JSON-Guidelines-(Complete)) in Boxalino Intelligence Admin; test, save &amp; publish.

    - Layout Blocks (Boxalino Intelligence Admin &gt;&gt; Marketing &gt;&gt; Layout Blocks)
    - Template Resources (Boxalino Intelligence Admin &gt;&gt; Advanced &gt;&gt; Template Resources)
    - Narratives (Boxalino Intelligence Admin &gt;&gt; Marketing &gt;&gt; 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)

Documentation available in the [Magento 2 Integration Introduction](https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/392396801/Magento+2)

More documentation is available on each dependency repository wiki page:

1. [exporter layer](https://github.com/boxalino/exporter-magento2/wiki)
2. [framework layer](https://github.com/boxalino/rtux-magento2/wiki)
3. [integration usecases](https://github.com/boxalino/rtux-integration-magento2/wiki)
4. [API php wiki](https://github.com/boxalino/rtux-api-php/wiki)

Contact us!
-----------

[](#contact-us)

If you have any question, just contact us at

###  Health Score

54

—

FairBetter than 97% of packages

Maintenance98

Actively maintained with recent releases

Popularity9

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity85

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~56 days

Recently: every ~329 days

Total

39

Last Release

9d ago

Major Versions

2.3.0 → 3.0.02021-11-23

1.0.0.2 → 3.1.02022-02-08

1.2.39 → 3.2.02022-05-10

3.4.0 → 4.0.02024-01-16

1.0.0.4 → 5.0.02026-05-08

PHP version history (7 changes)1.0.0PHP &gt;=7.2

1.0.11.30PHP ^7.0

1.2.0PHP ^7.2

2.2.0PHP &gt;=7.4

3.4.0PHP &gt;=8.1

1.0.0.3PHP &gt;=8.3

5.0.0PHP &gt;=8.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/89669a902ad5ae0993e382c3038e3e1e338771c3c15598ad2cddb06d314901d8?d=identicon)[dannegwork](/maintainers/dannegwork)

---

Top Contributors

[![dannegwork](https://avatars.githubusercontent.com/u/42143313?v=4)](https://github.com/dannegwork "dannegwork (115 commits)")

---

Tags

real-timeintegrationmagento2personalizationboxalinortux

### Embed Badge

![Health badge](/badges/boxalino-rtux-integration-magento2/health.svg)

```
[![Health](https://phpackages.com/badges/boxalino-rtux-integration-magento2/health.svg)](https://phpackages.com/packages/boxalino-rtux-integration-magento2)
```

###  Alternatives

[smile/elasticsuite

Magento 2 merchandising and search engine built on ElasticSearch

8044.5M33](/packages/smile-elasticsuite)[pubnub/pubnub

This is the official PubNub PHP SDK repository.

1314.6M17](/packages/pubnub-pubnub)[wordpress/mcp-adapter

Adapter for Abilities API, letting WordPress abilities to be used as MCP tools, resources or prompts

74855.8k1](/packages/wordpress-mcp-adapter)[mollie/magento2

Mollie Payment Module for Magento 2

1121.6M10](/packages/mollie-magento2)[coreproc/nova-echo

Adds Laravel Echo with your broadcast configuration to your Laravel Nova app

1996.9k2](/packages/coreproc-nova-echo)[tbondois/odoo-ripcord

Ripoo : a PHP8 XML-RPC client handler for Odoo External API

16124.3k1](/packages/tbondois-odoo-ripcord)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
