MageContentReactions - User & Installation Guide

Enhance your Adobe Commerce store with interactive content reactions. This extension allows customers to express their feelings about your CMS pages through emojis.

1. Overview

The MageContentReactions extension by SomePlus is a lightweight, performance-oriented tool designed for Adobe Commerce (Magento 2). It injects a modern, AJAX-based reaction block into your CMS pages, encouraging user engagement without affecting page load speeds.

Key Features:

• 6 Interactive Emojis: Like, Love, Haha, Wow, Sad, and Celebrate.
• Full Page Cache (FPC) Friendly: Uses AJAX to load and sync reaction data.
• Guest & Customer Support: Allow everyone or only logged-in users to react.
• Responsive Design: Works perfectly on mobile, tablet, and desktop.
• Admin Controls: Enable/Disable globally or on specific pages.

2. Installation Guide

Prerequisites

• Magento 2.x (Open Source or Adobe Commerce)
• PHP 8.1 or higher

Installation Steps (Manual)

1. Upload: Extract the extension package and upload it to your Magento installation under the following directory: app/code/SomePlus/MageContentReactions/
2. Enable Module: Run the following command in your Magento root directory:

   php bin/magento module:enable SomePlus_MageContentReactions
   

3. Upgrade Database: Apply the database schema:

   php bin/magento setup:upgrade
   

4. Compile Code: Generate dependency injection classes:

   php bin/magento setup:di:compile
   

5. Deploy Assets: (Required if in production mode):

   php bin/magento setup:static-content:deploy
   

6. Clear Cache:

   php bin/magento cache:flush
   

3. Configuration (Admin Panel)

Once installed, go to Stores > Configuration > SomePlus > Content Reactions.

General Settings

• Enable Module: Master switch for the extension.
• Allow Guest Reactions: Set to 'Yes' to allow non-logged-in users to interact.
• Reaction Types: Customize which emojis you want to display.

Display Settings

• Show on CMS Pages: Automatically inject the block into all CMS pages.
• Excluded Page Identifiers: List specific pages where you don't want the reaction block to appear (e.g., home, privacy-policy).
• Position: Choose to show reactions before or after the main content.
• Show Reaction Counts: Display how many people have clicked each emoji.

4. Frontend Usage

The extension automatically detects when it's on a CMS page and renders the block.

• Interacting: Users click an emoji to react. A second click on the same emoji removes the reaction.
• Privacy: If guest reactions are disabled, users will be prompted to log in.
• Feedback: Real-time messages (e.g., "You reacted with ❤️") provide immediate feedback to the user.

5. Troubleshooting & Support

• Reactions not showing? Ensure the module is enabled in configuration and run bin/magento cache:flush.
• Counts not updating? Check your browser console for AJAX errors. Ensure permissions for /var/log are correct to see extension logs.

For dedicated support, visit: https://someplus.work/support
Email: [email protected]

© 2024 SomePlus. All rights reserved.

Release Notes

[1.0.0] - 2024-01-13

Added

• Initial release of MageContentReactions for Adobe Commerce.
• Built-in support for 6 reaction types (Like, Love, Haha, Wow, Sad, Celebrate).
• Full Page Cache (FPC) compatibility using AJAX data sourcing.
• Comprehensive Admin Configuration panel:
  • Globalization: Toggle the extension on or off.
  • Security: Enable/Disable guest reactions.
  • Customization: Choose which reactions to display.
  • Targeting: Exclude specific CMS pages by identifier.
  • Layout: Option to position the block before or after page content.
• Secure AJAX handling with CSRF validation and form key integration.
• Responsive frontend UI with modern CSS gradients and animations.
• Dark Mode support based on system preferences.
• PSR-4 compliant architecture and optimized database schema.