setono/sylius-plugin-skeleton

Acme example plugin for Sylius.

dev-master / 1.0.x-dev 2022-04-08 09:38 UTC

Requires

• php: >=7.4
• symfony/config: ^4.4 || ^5.4
• symfony/dependency-injection: ^4.4 || ^5.4
• symfony/http-kernel: ^4.4 || ^5.4

Requires (Dev)

• api-platform/core: ^2.6
• friendsofsymfony/oauth-server-bundle: >2.0.0-alpha.0 ^2.0@dev
• lexik/jwt-authentication-bundle: ^2.15
• matthiasnoback/symfony-config-test: ^4.3
• matthiasnoback/symfony-dependency-injection-test: ^4.3
• phpunit/phpunit: ^9.5
• psalm/plugin-phpunit: ^0.16.0
• psalm/plugin-symfony: ^3.1
• roave/security-advisories: dev-latest
• setono/code-quality-pack: ^2.1.3
• sylius/admin-api-bundle: ^1.10
• sylius/sylius: ~1.10.11
• symfony/debug-bundle: ^4.4 || ^5.4
• symfony/dotenv: ^4.4 || ^5.4
• symfony/intl: ^4.4 || ^5.4
• symfony/maker-bundle: ^1.36
• symfony/property-info: ^4.4 || ^5.4
• symfony/serializer: ^4.4 || ^5.4
• symfony/web-profiler-bundle: ^4.4 || ^5.4
• symfony/webpack-encore-bundle: ^1.13

Conflicts

• symfony/security-bundle: 5.4.0

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:dev-master 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 setup a plugin's database, remember to configure you database credentials in tests/Application/.env and tests/Application/.env.test.