setono/sylius-plugin-skeleton

Acme example plugin for Sylius.

2.2.x-dev 2026-04-20 12:11 UTC

Requires

• php: >=8.2
• sylius/core-bundle: ^2.2
• symfony/config: ^6.4 || ^7.4
• symfony/dependency-injection: ^6.4 || ^7.4
• symfony/http-kernel: ^6.4 || ^7.4

Requires (Dev)

• api-platform/symfony: ^4.3.3
• payum/core: ^1.7.5
• setono/sylius-plugin: ^2.0
• sylius/grid-bundle: ^1.15
• sylius/sylius: ~2.2.5
• symfony/debug-bundle: ^6.4 || ^7.4
• symfony/dotenv: ^6.4 || ^7.4
• symfony/intl: ^6.4 || ^7.4
• symfony/property-info: ^6.4 || ^7.4
• symfony/serializer: ^6.4 || ^7.4
• symfony/web-profiler-bundle: ^6.4 || ^7.4
• symfony/webpack-encore-bundle: ^2.2

MIT

• sylius
• sylius-plugin

README

Setono have made a bunch of plugins for Sylius, and we have some guidelines that we try to follow when developing plugins. These guidelines are used in this repository, and it gives you a very solid base when developing plugins.

Enjoy!

Quickstart

1. Run

   composer create-project --prefer-source --no-install --remove-vcs setono/sylius-plugin-skeleton:2.2.x-dev ProjectName

   or just click the Use this template button at the right corner of this repository.

2. Run

   cd ProjectName && composer install

3. From the plugin skeleton root directory, run the following commands:

   php init
   (cd tests/Application && yarn install)
   (cd tests/Application && yarn build)
   (cd tests/Application && bin/console assets:install)
   
   (cd tests/Application && bin/console doctrine:database:create)
   (cd tests/Application && bin/console doctrine:schema:create)
   
   (cd tests/Application && bin/console sylius:fixtures:load -n)

4. Start your local PHP server: symfony serve (see https://symfony.com/doc/current/setup/symfony_server.html for docs)

To be able to set up a plugin's database, remember to configure you database credentials in tests/Application/.env and tests/Application/.env.test.