sylius/store-assembler

Sylius Store Assembler – tool to assemble Sylius stores from a set of configuration files.

v0.1.0 2025-06-17 11:47 UTC

Requires

• php: >=8.2
• composer/semver: ^3.4
• symfony/console: ^6.0 || ^7.0
• symfony/filesystem: ^6.0 || ^7.0
• symfony/framework-bundle: ^6.0 || ^7.0
• symfony/process: ^6.0 || ^7.0
• symfony/yaml: ^6.0 || ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpstan/phpstan: ^2.0
• rector/rector: ^2.0

MIT

README

Sylius Store Assembler is a Symfony bundle that streamlines creating and configuring Sylius-based e-commerce stores using store presets.

Installation

Install the package via Composer:

composer require sylius/store-assembler

Enable the Bundle

If your application does not auto-register bundles, add the following entry to config/bundles.php:

<?php
return [
    // ...
    Sylius\StoreAssemblerBundle\SyliusStoreAssemblerBundle::class => ['all' => true],
];

Store Preset Structure

Create a store preset directory with this structure:

store-preset/
├── fixtures/
│   ├── fixtures.yaml
│   └── images/
│       └── <your_image_files>
├── store-preset.json
└── themes/
    └── shop/
        ├── banner.png
        └── logo.png

You can find example presets in the Sylius StorePreset repository.

Usage

Add the following targets to your Makefile for common tasks:

sylius-store-assembler:
    vendor/bin/sylius-store-assembler

sylius-store-assembler-fixtures:
    bin/console sylius:store-assembler:fixture:prepare
    bin/console cache:clear
    bin/console cache:warmup
    bin/console sylius:store-assembler:fixture:load

sylius-store-assembler-theme:
    bin/console sylius:store-assembler:theme:prepare
    bin/console cache:clear
    bin/console cache:warmup

Run all steps with:

make sylius-store-assembler

For granular control, use individual console commands:

php bin/console sylius:store-assembler:plugin:prepare
php bin/console sylius:store-assembler:plugin:install
php bin/console sylius:store-assembler:fixture:prepare
php bin/console sylius:store-assembler:fixture:load
php bin/console sylius:store-assembler:theme:prepare

Configuration

• Plugin Manifests: Place JSON manifests in config/plugins/{vendor}/{plugin-name}/{major.minor}/manifest.json.

Manifests support:

• Steps: List of shell commands (e.g., composer require).
• Configurators: Implementations of Sylius\StoreAssemblerBundle\Configurator\ConfiguratorInterface.

Example manifest:

{
  "steps": [
    "yarn add some/package"
  ],
  "configurators": [
    {
      "class": "Sylius\\\\StoreAssemblerBundle\\\\Configurator\\\\YamlNodeConfigurator",
      "file": "config/packages/my_package.yaml",
      "key": "my_package.some_configuration_key.enabled",
      "value": true
    }
  ]
}

Contributing

Contributions are welcome! By submitting a pull request, you agree to license your changes under the MIT License. Please follow the existing project conventions and tests.

License

This project is released under the MIT License.