Category Slider Widget

1. Requirements

Before installing Jscriptz Subcats, ensure your environment meets the following requirements:

2. Composer Installation

If you purchased the extension from the Adobe Commerce Marketplace, you can install and manage it via Composer.

2.1 Configure Marketplace Authentication

If you haven't already, add your Magento Marketplace credentials to your auth.json file:

composer config --global http-basic.repo.magento.com <public_key> <private_key>

You can find your access keys in your Marketplace account.

2.2 Install the Extension

# Require the package from Magento Marketplace
composer require jscriptz/module-subcats

# Enable the module
bin/magento module:enable Jscriptz_Subcats

# Run setup upgrade to install database schema
bin/magento setup:upgrade

# Compile dependency injection
bin/magento setup:di:compile

# Deploy static content (production mode)
bin/magento setup:static-content:deploy -f

# Clear all caches
bin/magento cache:flush

3. Manual Installation (app/code folder)

If you received the extension as a zip file or prefer manual installation without Composer, you can install directly into the app/code directory.

3.1 Download and Extract

Jscriptz/
    Subcats/
        registration.php
        etc/
        Model/
        ViewModel/
        view/
        ...

3.2 Copy Files to Magento

mkdir -p app/code/Jscriptz

cp -r /path/to/extracted/Jscriptz/Subcats app/code/Jscriptz/

app/
    code/
        Jscriptz/
            Subcats/
                registration.php
                etc/
                    module.xml
                    ...

3.3 Enable the Module

After copying the files, run the following commands from your Magento root directory:

# Verify the module is recognized
bin/magento module:status Jscriptz_Subcats

# Enable the module
bin/magento module:enable Jscriptz_Subcats

# Run setup upgrade to install database schema
bin/magento setup:upgrade

# Compile dependency injection
bin/magento setup:di:compile

# Deploy static content (production mode)
bin/magento setup:static-content:deploy -f

# Clear all caches
bin/magento cache:flush

chmod -R 755 app/code/Jscriptz/Subcats
chown -R www-data:www-data app/code/Jscriptz/Subcats

3.4 FTP/SFTP Upload

If you don't have SSH access, you can upload via FTP/SFTP:

4. Verify Installation

After installation, verify that Jscriptz Subcats is properly installed and active.

4.1 Check Module Status

Run the following command to confirm the module is enabled:

bin/magento module:status Jscriptz_Subcats

You should see: Module is enabled

4.2 Verify Admin Configuration

Magento Admin Configuration - JSCRIPTZ section with Jscriptz Subcats settings

4.3 Verify Database Table

The installation creates a new database table for custom presets. You can verify this with:

bin/magento setup:db-declaration:generate-whitelist --module-name=Jscriptz_Subcats

Or check directly in your database for the table: jscriptz_subcats_custom_preset

5. Post-Installation Configuration

Once installed, follow these steps to get started:

5.1 Enable the Module

5.2 Quick Start

For detailed configuration instructions, refer to the Jscriptz Subcats User Guide, which covers:

• Global design configuration
• Theme presets and custom presets
• Category-level setup
• Widget placement in CMS pages and blocks
• Hyvä theme compatibility

6. Uninstallation

If you need to remove the extension:

6.1 Disable the Module

# Disable the module first
bin/magento module:disable Jscriptz_Subcats
bin/magento cache:flush

6.2 Run Cleanup Script (Recommended)

Before removing the module files, run the cleanup script to remove all extension data including database tables, EAV attributes, and custom presets:

bin/magento jscriptz:subcats:cleanup

This command will:

• Remove the jscriptz_subcats_custom_preset database table
• Remove all custom category EAV attributes added by the extension
• Clean up any related configuration data

6.3 Remove via Composer

# Remove the module via Composer
composer remove jscriptz/module-subcats

# Run setup upgrade to finalize removal
bin/magento setup:upgrade

# Recompile and clear caches
bin/magento setup:di:compile
bin/magento cache:flush

6.4 Manual Cleanup (Alternative)

If you didn't run the cleanup script, you can manually remove the extension data:

Database Table

DROP TABLE IF EXISTS jscriptz_subcats_custom_preset;

Category Attributes

Remove these EAV attributes from the eav_attribute table:

• is_subcat_enabled
• subcat_image
• subcat_children_order
• subcat_desktop_columns
• subcat_tablet_columns
• subcat_phone_columns

7. Upgrade Instructions

To upgrade Jscriptz Subcats to a newer version:

7.1 Via Composer

If you installed via Composer:

# Update the module
composer update jscriptz/module-subcats

# Run database upgrades
bin/magento setup:upgrade

# Compile and deploy
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f
bin/magento cache:flush

7.2 Manual Upgrade

If you installed manually via the app/code folder:

bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f
bin/magento cache:flush

8. Support & Resources