Skip to content
/ SyliusPluginSkeleton Public template

The place to start when you want to develop a Sylius plugin

License

Notifications You must be signed in to change notification settings

Setono/SyliusPluginSkeleton

Repository files navigation

Setono Sylius Plugin Skeleton

Latest Version Software License Build Status Code Coverage Mutation testing

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.