Skip to content

Installing the Admin Dashboard

This guide covers installing the Hyvä Commerce Admin Dashboard module with Composer, both with a license key and via the Hyvä Commerce GitLab repositories for agency and technology partners. Once installed, the dashboard replaces the default Magento admin dashboard with configurable widgets.

Prerequisites

See Hyvä Commerce Prerequisites.

Installation

With a License Key

  1. Require the hyva-themes/commerce-module-admin-dashboard package 

    composer require hyva-themes/commerce-module-admin-dashboard

  2. (optional) Require the hyva-themes/commerce-module-admin-dashboard-google-crux-history-widget package 

    composer require hyva-themes/commerce-module-admin-dashboard-google-crux-history-widget

  3. (optional) Require the hyva-themes/commerce-module-admin-dashboard-cms-widgets package 

    composer require hyva-themes/commerce-module-admin-dashboard-cms-widgets

  4. (optional)* Require the hyva-themes/commerce-theme-adminhtml package 

    composer require hyva-themes/commerce-theme-adminhtml

  5. Run bin/magento setup:upgrade

Contract package

hyva-themes/commerce-module-admin-dashboard-api is the stable widget contract package. It is installed transitively as a dependency of the dashboard module and does not need to be required explicitly. Custom widget modules should depend on it directly so they compile without the dashboard runtime; see the Dashboard API reference.

*Admin Theme

While the default Magento/Adobe/Mage-OS admin themes are supported, we recommend installing the Hyvä Admin Theme for the best visual experience when using the Admin Dashboard.

For Agency and Technology Partners

If you have access to the Hyvä Commerce GitLab repositories as Gold/Platinum Agency Partner, or a Technology Partner, you can install Hyvä Commerce in development environments using SSH key authentication.

You can configure the git repositories in your root composer.json and use the repositories directly as git repos beneath your vendor directory. You can check out tags and branches, make commits and push contributions.

This installation method is not suited for deployments, because GitLab requires SSH key authorization.

  1. Ensure your public SSH key is added to your account on gitlab.hyva.io.

  2. Set minimum-stability to dev in the Magento composer.json 

    composer config minimum-stability dev

  3. Add the Admin Dashboard and base Hyvä Commerce module repositories to the Magento composer.json 

    composer config repositories.hyva-themes/commerce-module-commerce git git@gitlab.hyva.io:hyva-commerce/module-commerce.git
composer config repositories.hyva-themes/commerce-module-admin-dashboard-api git git@gitlab.hyva.io:hyva-themes/commerce-module-admin-dashboard-api.git
composer config repositories.hyva-themes/commerce-module-admin-dashboard git git@gitlab.hyva.io:hyva-commerce/module-admin-dashboard.git

  4. (optional) Add the Admin Dashboard CrUX Widget, CMS Widgets, and Admin Theme repositories to the Magento composer.json 

    composer config repositories.hyva-themes/commerce-module-admin-dashboard-google-crux-history-widget git git@gitlab.hyva.io:hyva-commerce/module-admin-dashboard-google-crux-history-widget.git
composer config repositories.hyva-themes/commerce-module-admin-dashboard-cms-widgets git git@gitlab.hyva.io:hyva-commerce/module-admin-dashboard-cms-widgets.git
composer config repositories.hyva-themes/commerce-module-admin-theme git git@gitlab.hyva.io:hyva-commerce/module-admin-theme.git
composer config repositories.hyva-themes/commerce-theme-adminhtml git git@gitlab.hyva.io:hyva-commerce/theme-adminhtml.git

  5. Require the hyva-themes/commerce-module-admin-dashboard package 

    composer require hyva-themes/commerce-module-admin-dashboard:dev-main

  6. (optional) Require the hyva-themes/commerce-module-admin-dashboard-google-crux-history-widget package 

    composer require hyva-themes/commerce-module-admin-dashboard-google-crux-history-widget:dev-main

  7. (optional) Require the hyva-themes/commerce-module-admin-dashboard-cms-widgets package 

    composer require hyva-themes/commerce-module-admin-dashboard-cms-widgets:dev-main

  8. (optional) Require the hyva-themes/commerce-theme-adminhtml package 

    composer require hyva-themes/commerce-theme-adminhtml:dev-main

  9. Run bin/magento setup:upgrade

Additional Setup

No further steps are required. For more details on how to configure Admin Dashboard settings, see the configuration guide.