README

The Inspeya Brand module for Magento 2 dynamically lists all the brands with products in stock, allowing customers to view and browse products by their favorite brands. This module provides seamless integration with your Magento store and enhances the shopping experience by updating brand listings based on real-time inventory levels.

Module Overview

• Module Name: MHinspeya Brand
• Version: 1.0.0
• License: OSL-3.0
• Type: Magento 2 Module
• Description: The module dynamically generates a list of brands with available stock. The list is updated in real-time based on inventory changes. Customers can browse products by brand, view in-stock items, and filter by availability. The module also provides SEO-friendly URLs, widgets for brand display, and detailed reports for admins.

Key Features

1. Dynamic Brand Listing

• Automatically generates a list of brands that have at least one product in stock.
• Real-time updates based on inventory changes (e.g., out-of-stock products are removed).

2. Filter by Inventory

• Customers can filter the list to only display brands with products available for purchase.

3. Brand Page

• Each brand name in the list is clickable, leading to a dedicated brand page showcasing all in-stock products.
• Options for sorting, filtering, and searching within the brand’s product catalog.

4. SEO-Friendly URLs

• The module generates SEO-friendly URLs for each brand page, helping to improve search engine visibility.

5. Inventory-Based Brand Widget

• Place a widget on various parts of the website (e.g., homepage, sidebar, footer) to highlight popular or new brands with available stock.

6. Admin Configuration

• Configure how brands are displayed (e.g., sorting by popularity, alphabetical order).
• Options to include/exclude specific brands from the list regardless of their stock status.

7. Caching Mechanism

• Caching ensures fast loading times by storing brand lists, refreshing only when inventory changes.

8. Integration with Other Features

• Product Pages: Brand name links directly to the brand’s page from each product page.
• Search Functionality: When customers search for a brand, the results include the brand page and all relevant products.

9. Customizable Design

• Fully customizable front-end to match your store’s design.

10. Reporting and Analytics

• Provides insights on brand performance, including metrics such as most viewed brands and highest sales.

11. Multi-Store Support

• Supports configuration per store view, enabling different regions or languages to highlight different brands.

Installation

Composer Installation

To install this module via Composer, follow these steps:

1. Run the following command in your Magento project’s root directory:

   composer require mhinspeya/mhinspeya-brand
   

2. After installation, run the following commands to enable the module and clear the cache:

   php bin/magento module:enable MHinspeya_Brand
   php bin/magento setup:upgrade
   php bin/magento cache:flush
   

3. If you are in production mode, deploy the static content:

   php bin/magento setup:static-content:deploy
   

Manual Installation

If you prefer to install the module manually, follow these steps:

1. Download the module’s files from the repository or from the package you received.

2. Upload the module to your Magento installation:

   Place the contents in the app/code/MHinspeya/Brand/ directory.

3. After uploading, enable the module by running the following commands:

   php bin/magento module:enable MHinspeya_Brand
   php bin/magento setup:upgrade
   php bin/magento cache:flush
   

4. If you are in production mode, deploy the static content:

   php bin/magento setup:static-content:deploy
   

   Admin Configuration

Once installed, you can configure the module settings via the Magento admin panel.

1. Go to Stores > Configuration > MHinspeya > Brand.

2. You can configure:

• Brand Setting: Configure the general brand settings for the module.
• Manage Brand: Add, edit, and manage the brands listed in the module.
• Manage Groups: Organize brands into groups for better management and display.
• Manage Brand Menu: Configure the display options for the brand menu, including placement and visibility on your store’s frontend.

Usage

Brand Pages

Each brand will have a dedicated page displaying all products currently in stock for that brand. Customers can browse, filter, and search products within the brand’s catalog.

Reporting and Analytics

The module provides reports that show:

The most frequently viewed brands. The brands with the highest sales. Inventory changes and performance metrics.

Compatibility

This module is fully compatible with Magento 2.x versions. Ensure your Magento installation meets the required version for this module to function properly.

License

This module is licensed under the Open Software License 3.0 (OSL-3.0).