README

Plugin Skeleton

Skeleton for starting Sylius plugins.

Installation

1. Run composer create-project sylius/plugin-skeleton ProjectName.

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

   $ (cd tests/Application && yarn install)
   $ (cd tests/Application && yarn build)
   $ (cd tests/Application && bin/console assets:install public -e test)
   
   $ (cd tests/Application && bin/console doctrine:database:create -e test)
   $ (cd tests/Application && bin/console doctrine:schema:create -e test)

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

Usage

Running plugin tests

• PHPUnit

  $ vendor/bin/phpunit

• PHPSpec

  $ vendor/bin/phpspec run

• Behat (non-JS scenarios)

  $ vendor/bin/behat --tags="~@javascript"

• Behat (JS scenarios)

  1. Download Chromedriver

  2. Download Selenium Standalone Server.

  3. Run Selenium server with previously downloaded Chromedriver:

     $ java -Dwebdriver.chrome.driver=chromedriver -jar selenium-server-standalone.jar

  4. Run test application's webserver on localhost:8080:

     $ (cd tests/Application && bin/console server:run localhost:8080 -d public -e test)

  5. Run Behat:

     $ vendor/bin/behat --tags="@javascript"

Opening Sylius with your plugin

• Using test environment:

  $ (cd tests/Application && bin/console sylius:fixtures:load -e test)
  $ (cd tests/Application && bin/console server:run -d public -e test)

• Using dev environment:

  $ (cd tests/Application && bin/console sylius:fixtures:load -e dev)
  $ (cd tests/Application && bin/console server:run -d public -e dev)