Skip to content

Latest commit

 

History

History
98 lines (81 loc) · 2.23 KB

installation.md

File metadata and controls

98 lines (81 loc) · 2.23 KB

Installation

Overview:

GENERAL


ADDITIONAL


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 >= 20.x

Composer:

composer require bitbag/banner-plugin --no-scripts

Basic configuration:

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

# config/bundles.php

return [
    ...
    BitBag\SyliusBannerPlugin\BitBagSyliusBannerPlugin::class => ['all' => true],
];

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

# config/packages/_sylius.yaml

imports:
    ...
    - { resource: "@BitBagSyliusBannerPlugin/Resources/config/config.yaml" }

Add routing to your config/routes.yaml file:

# config/routes.yaml

bitbag_sylius_banner_plugin:
    resource: "@BitBagSyliusBannerPlugin/Resources/config/routing.yaml"

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

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

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.

Tests

To run the tests, execute the commands:

composer install
cd tests/Application
yarn install
yarn run gulp
bin/console assets:install public -e test
bin/console doctrine:schema:create -e test
bin/console server:run 127.0.0.1:8080 -d public -e test
open http://localhost:8080
vendor/bin/behat
vendor/bin/phpspec run

Known issues

Translations not displaying correctly

For incorrectly displayed translations, execute the command:

bin/console cache:clear