installation.md

Installation

Overview:

GENERAL

• Requirements
• Composer
• Basic configuration

---

ADDITIONAL

• Known Issues

---

Requirements:

We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.

Package	Version
PHP	>=8.0
sylius/sylius	1.12.x - 1.13.x
MySQL	>= 5.7
NodeJS	>= 18.x

Composer:

composer require bitbag/shipping-export-plugin

Basic configuration:

Add plugin dependencies to your config/bundles.php file:

# config/bundles.php

return [
    ...
    BitBag\SyliusShippingExportPlugin\BitBagSyliusShippingExportPlugin::class => ['all' => true],
];

Import required config in your config/packages/_sylius.yaml file:

# config/packages/_sylius.yaml

imports:
    ...
    - { resource: "@BitBagSyliusShippingExportPlugin/Resources/config/config.yml" }

Import routing in your config/routes.yaml file:

# config/routes.yaml

bitbag_shipping_export_plugin:
    resource: "@BitBagSyliusShippingExportPlugin/Resources/config/routing.yml"
    prefix: /admin

Update your database

First, please run legacy-versioned migrations by using command:

bin/console doctrine:migrations:migrate

After migration, please create a new diff migration and update database:

bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate

Clear application cache by using command:

bin/console cache:clear

Note: If you are running it on production, add the -e prod flag to this command.

Known issues

Translations not displaying correctly

For incorrectly displayed translations, execute the command:

bin/console cache:clear