# Installation

# Requirements

## **ConvertixCheckout for Hyvä Theme**

<p class="callout warning"><span style="white-space: pre-wrap;">This module is compatible only with </span>[**Hyvä Theme**](https://hyva.io/). Luma-based storefronts are not supported.</p>

- <span style="white-space: pre-wrap;">Magento Community edition </span>`<span class="editor-theme-code">2.4.4-p9</span>`<span style="white-space: pre-wrap;">, </span>`<span class="editor-theme-code">2.4.5-p8</span>`<span style="white-space: pre-wrap;">, </span>`<span class="editor-theme-code">2.4.6-p7</span>`<span style="white-space: pre-wrap;">, </span>`<span class="editor-theme-code">2.4.7-p1</span>`<span style="white-space: pre-wrap;"> or higher</span>
- <span style="white-space: pre-wrap;">PHP </span>`<span class="editor-theme-code">8.1</span>`<span style="white-space: pre-wrap;">, </span>`<span class="editor-theme-code">8.2</span>`<span style="white-space: pre-wrap;">, </span>`<span class="editor-theme-code">8.3</span>`<span style="white-space: pre-wrap;"> or </span>`<span class="editor-theme-code">8.4</span>`
- [**Hyvä Themes**](https://hyva.io) **installed and activated**
- Composer 2.x
- OpenSearch configured
- SSH/CLI access to the Magento server

# Prerequisites

## **ConvertixCheckout for Hyvä Theme**

<p class="callout warning"><span style="white-space: pre-wrap;">This module is compatible only with </span>[**Hyvä Theme**](https://hyva.io/). Luma-based storefronts are not supported.</p>

#### Before Installation

<p class="callout info"><span style="white-space: pre-wrap;">Before installing the module, </span>**it is strongly recommended to create a full backup of your Magento instance.**</p>

##### Backup your Magento 2 instance

<span style="color: rgb(34, 34, 34); background-color: rgb(255, 255, 255);">The backup feature is disabled by default. To enable, enter the following CLI command:</span>

```shell
php bin/magento config:set system/backup/functionality_enabled 1
```

**Then:**

```shell
php bin/magento setup:backup --code --db
```

##### Restoring Magento 2 instance

**First run:**

```
php bin/magento info:backups:list
```

To check your backups saved into filesystem.

**Then run:**

```
php bin/magento setup:rollback -f 1434133011_filesystem.tgz -d 1434133011_db.sql
```

<p class="callout info"><span style="white-space: pre-wrap;">Replace </span>**14134133011\_**<span style="white-space: pre-wrap;"> with your backup file name.</span></p>

##### Composer repository file backup

```
cp composer.json composer.json.bak
cp composer.lock composer.lock.bak
```

#### Recommended Testing Environment

Before deploying the module to a production store, it is strongly recommended to test the installation in a development or staging environment first.

Recommended environments:

- Development domain
- Staging server
- Local Magento instance

This helps validate:

- Theme compatibility
- Third-party module compatibility
- Checkout behavior
- JavaScript functionality
- Customizations specific to the store

Example:

```
dev.yourstore.com
staging.yourstore.com
```

# Installation Guide

## **ConvertixCheckout for Hyvä Theme**

<p class="callout warning"><span style="white-space: pre-wrap;">This module is compatible only with </span>[**Hyvä Theme**](https://hyva.io). Luma-based storefronts are not supported.</p>

##### Maintenance Mode (Optional)

```
php bin/magento maintenance:enable
```

#### Installation Methods

##### **Method 1 - Composer Installation (Recommended**)

```html
composer require tmgcode/module-convertixcheckout
php bin/magento module:enable TmgCode_ConvertixCheckout
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
php bin/magento cache:flush
php bin/magento maintenance:disable
```

##### **Method 2 - Manual Installation**

**Extract the module archive into:**

```
app/code/TmgCode/ConvertixCheckout
```

**Then run:**

```
php bin/magento module:enable TmgCode_ConvertixCheckout
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
php bin/magento cache:flush
php bin/magento maintenance:disable
```