Skip to content

Installation & Configuration

Hyvä Commerce is an 'Early Access' product currently under development.

Early Access means that not all features of Hyvä Commerce are fully completed or released, and many areas are still under heavy development and may change. However, it means you can get your hands on everything currently available and being worked on, with a license. Find out more on our Early Access page.

Install Options

There are 2 main ways to install and use Hyvä Commerce:

  1. Installing all available features (packages) via the Hyvä Commerce metapackage
  2. Installing just the individual modules, themes or other packages you wish to use

Metapackage Recommendation

While we support both of the above approaches, we recommend the metapackage approach because it not only provides all the best features, many of which are enhanced when utilised together, but also because we define and test against the specific versions included within each release with one another, which provides a more reliable experience. Unused features can still be disabled at module or configuration level.

Prerequisites

  • A Hyvä Commerce license (Private Packagist key) or a GitLab account with Hyvä Commerce Agency (Platinum/Gold) or Technology Partner access
  • Hyvä Default Theme 1.3.0 or later (or a cloned/child theme based on 1.3.0 or later)
  • Hyvä Theme Module 1.3.12 or later
  • Magento Open Source, or Adobe Commerce 2.4.4 or later

    Both Adobe Commerce Cloud and On-Premise versions are supported*.

  • PHP 8.1 or later

Hyvä Checkout

Hyvä Checkout is not a required prerequisite, but if it is utilised within your project, it would be advised to install alongside Hyvä Theme before proceeding to install Hyvä Commerce."

*Adobe Commerce Feature Support

A Hyvä Enterprise license is still required for Adobe Commerce, B2B and additional services feature compatibility.

Installation

With a License Key

The below instructions are for installing all features via the Hyvä Commerce metapackage. For installing individual features, please see the relevant feature installation instructions under the Features section.

  1. Require the hyva-themes/commerce package
composer require hyva-themes/commerce

  1. Run bin/magento setup:upgrade

  2. Run tailwind to generate storefront styles, replacing vendor/hyva-themes/magento2-default-theme/web/tailwind/ with the path to your theme's web/tailwind folder: 

    bin/magento hyva:config:generate
npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ ci
npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ run build-prod

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 repo's 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 following repositories to the Magento composer.json 

    composer config repositories.hyva-themes/commerce git git@gitlab.hyva.io:hyva-commerce/metapackage-commerce.git
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-cms git git@gitlab.hyva.io:hyva-commerce/module-cms.git

  4. Require the hyva-themes/commerce package using the dev-main branch version: 

    composer require --prefer-source 'hyva-themes/commerce:dev-main'

  5. Run bin/magento setup:upgrade

  6. Run tailwind to generate storefront styles, replacing vendor/hyva-themes/magento2-default-theme/web/tailwind/ with the path to your theme's web/tailwind folder: 

    bin/magento hyva:config:generate
npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ ci
npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ run build-prod

Additional Configuration

For stores with multiple domains, please see the following steps for Hyvä CMS.