aimes/magento2-module-substratum

N/A

1.2.1 2025-01-09 20:31 UTC

Requires

• composer/composer: ^2.0
• magento/framework: *

GPL-3.0-or-later

• Rob Aimes

README

• Compatible with Magento Open Source and Adobe Commerce 2.4.x
• Compatible with Mage OS

NOTE: This module provides no out-of-the-box functionality. All features are opt-in and exist purely for the benefit of other modules to utilise.

Features

• A top-level admin menu item for all Aimes modules, for ease-of-access. By default, this is disabled. This is to prevent unnecessary menu clutter for those who only have a small number of modules.
• An abstracted Composer package information provider, primarily used for update checks
• A custom SymfonyStyle class for easy access to helper methods, reducing 'clutter' when developing custom CLI commands and resulting in cleaner code
• A basic, yet accessible, collapsible UI component and accompanying template
• A 'navigator' model that provides observable values for:
  • Battery level
  • Battery charging status
  • Network status

Further details on each of the features can be found on the Substratum Wiki.

Requirements

• Magento Open Source or Adobe Commerce version 2.4.x

Installation

NOTE: This module should only be installed as the result of a dependent module installation.

Dependant modules can be found on Packagist.

Please install this module via Composer. This module is hosted on Packagist. If for some reason you still want to install this module independently, then please follow the below steps.

• composer require aimes/magento2-module-substratum
• bin/magento module:enable Aimes_Substratum
• bin/magento setup:upgrade

Usage

Please see the Substratum Wiki for usage instructions.

Preview

• ...

Planned Features / Improvments

• ...

Licence

GPLv3 © Rob Aimes