setono/sylius-plugin-skeleton

Acme example plugin for Sylius.

1.12.x-dev 2024-03-12 07:43 UTC

Requires

• php: >=8.1
• sylius/core-bundle: ^1.0
• symfony/config: ^5.4 || ^6.4 || ^7.0
• symfony/dependency-injection: ^5.4 || ^6.4 || ^7.0
• symfony/http-kernel: ^5.4 || ^6.4 || ^7.0

Requires (Dev)

• api-platform/core: ^2.7.16
• babdev/pagerfanta-bundle: ^3.8
• behat/behat: ^3.14
• doctrine/doctrine-bundle: ^2.11
• infection/infection: ^0.27.10
• jms/serializer-bundle: ^4.2
• lexik/jwt-authentication-bundle: ^2.17
• matthiasnoback/symfony-config-test: ^4.3 || ^5.1
• matthiasnoback/symfony-dependency-injection-test: ^4.3 || ^5.1
• phpunit/phpunit: ^9.6.17
• psalm/plugin-phpunit: ^0.18.4
• setono/code-quality-pack: ^2.7
• sylius/sylius: ~1.12.13
• symfony/debug-bundle: ^5.4 || ^6.4 || ^7.0
• symfony/dotenv: ^5.4 || ^6.4 || ^7.0
• symfony/intl: ^5.4 || ^6.4 || ^7.0
• symfony/property-info: ^5.4 || ^6.4 || ^7.0
• symfony/serializer: ^5.4 || ^6.4 || ^7.0
• symfony/web-profiler-bundle: ^5.4 || ^6.4 || ^7.0
• symfony/webpack-encore-bundle: ^1.17.2
• willdurand/negotiation: ^3.1

MIT

• sylius
• sylius-plugin

README

Setono have made a bunch of plugins for Sylius, and we have some guidelines which 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:1.12.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.