webgriffe/sylius-back-in-stock-notification-plugin

Timely inform customers and guest visitors when a product return in stock

1.0.0 2021-07-05 09:08 UTC

This package is auto-updated.

Last update: 2022-04-28 14:35:42 UTC


README

68747470733a2f2f64656d6f2e73796c6975732e636f6d2f6173736574732f73686f702f696d672f6c6f676f2e706e67

Back in Stock Notification Plugin

Plugin that add the possibility to receive an email notification when a product return in stock

Build Status

Features

Subscribe to get a Notification when a product return in stock

Subscription process for configurable product

Subscription for simple product

View your subscriptions in the apposite section of your account

See the apposite section in the my account

View your client subscriptions in the apposite admin section

See the apposite section in the admin account

Requirements

  • PHP ^7.3
  • Sylius ~1.8.0

Installation

  1. Run composer require webgriffe/sylius-back-in-stock-notification-plugin.

  2. Add the plugin to the config/bundles.php file:

Webgriffe\SyliusBackInStockNotificationPlugin\WebgriffeSyliusBackInStockNotificationPlugin::class => ['all' => true],
  1. Import the plugin routes by creating a file in config/routes/webgriffe_sylius_back_in_stock_notification_plugin.yaml with the follwing content:
webgriffe_sylius_back_in_stock_notification_plugin:
  resource: "@WebgriffeSyliusBackInStockNotificationPlugin/Resources/config/routing.yaml"
  1. Import required config in your config/packages/webgriffe_sylius_back_in_stock_notification_plugin.yaml file:
imports:
   - { resource: "@WebgriffeSyliusBackInStockNotificationPlugin/Resources/config/app/config.yaml" }
  1. Finish the installation by updating the database schema and installing assets:
bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate
bin/console assets:install
bin/console sylius:theme:assets:install

Configuration

This module send mail using a Symfony Command. Unfortunately, the command line context does not know about your VirtualHost or domain name. To fix this, you need to configure the “request context”, which is a fancy way of saying that you need to configure your environment so that it knows what URL it should use when generating URLs. For further information you can see Symfony Documentation.

  1. Edit the config/services.yml file by adding the following content:
parameters:
    router.request_context.host: example.org
    router.request_context.scheme: https
  1. As said early this module provide a command that check the stock of the product. You have to set the command bin/console webgriffe:back-in-stock-notification:alert in the crontab, once a day is enough:
0 12 * * * <absolute-php-path> <absolute-path-to-sylius-dir>/bin/console webgriffe:back-in-stock-notification:alert

Optional Configuration

If you want to use our Behat defined steps you have to include our Behat class in your autoloader-dev. To achieve this adds the following line to your composer.json:

"autoload-dev": {
    "psr-4": {
      "Tests\\Webgriffe\\SyliusBackInStockNotificationPlugin\\": "vendor/webgriffe/sylius-back-in-stock-notification-plugin/tests/"
    }
},

Contributing

To contribute to this plugin clone this repository, create a branch for your feature or bugfix, do your changes and then make sure al tests are passing.

(cd tests/Application && yarn install)
(cd tests/Application && yarn build)
(cd tests/Application && APP_ENV=test bin/console assets:install public)

(cd tests/Application && APP_ENV=test bin/console doctrine:database:create)
(cd tests/Application && APP_ENV=test bin/console doctrine:schema:create)

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

Running plugin tests

PHPUnit

vendor/bin/phpunit

PHPSpec

vendor/bin/phpspec run

Behat (non-JS scenarios)

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

Behat (JS scenarios)

  1. Install Symfony CLI command.

  2. Start Headless Chrome:

google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1
  1. Install SSL certificates (only once needed) and run test application's webserver on 127.0.0.1:8080:
symfony server:ca:install
APP_ENV=test symfony server:start --port=8080 --dir=tests/Application/public --daemon
  1. Run Behat:
vendor/bin/behat --strict --tags="@javascript"

Static Analysis

Psalm
vendor/bin/psalm
PHPStan
vendor/bin/phpstan analyse -c phpstan.neon -l max src/
Coding Standard
vendor/bin/ecs check src

Opening Sylius with your plugin

  • Using test environment:
(cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load)
(cd tests/Application && APP_ENV=test bin/console server:run -d public)
  • Using dev environment:
(cd tests/Application && APP_ENV=dev bin/console sylius:fixtures:load)
(cd tests/Application && APP_ENV=dev bin/console server:run -d public)

License

This plugin is under the MIT license. See the complete license in the LICENSE file.

Credits

Developed by Webgriffe®.