README

Coliship for Sylius

This plugin gives you an enhanced address with all Coliship fields (that's all for now).

Compatibility

Installation

If you want to use our recipes, you can configure your composer.json by running:

composer config --no-plugins --json extra.symfony.endpoint '["https://api.github.com/repos/monsieurbiz/symfony-recipes/contents/index.json?ref=flex/master","flex://defaults"]'

composer require monsieurbiz/sylius-coliship-plugin

Change your config/bundles.php file to add the line for the plugin :

<?php

return [
    //..
    MonsieurBiz\SyliusColishipPlugin\MonsieurBizSyliusColishipPlugin::class => ['all' => true],
];

Then create the config file in config/packages/monsieurbiz_coliship_plugin.yaml :

imports:
    - { resource: "@MonsieurBizSyliusColishipPlugin/Resources/config/monsieurbiz/settings.yaml" }
    - { resource: "@MonsieurBizSyliusColishipPlugin/Resources/config/sylius/grid.yaml" }
    - { resource: "@MonsieurBizSyliusColishipPlugin/Resources/config/sylius/ui.yaml" }

Then import the routes in config/routes/monsieurbiz_coliship_plugin.yaml :

monsieurbiz_coliship_admin:
    resource: "@MonsieurBizSyliusColishipPlugin/Resources/config/routes/admin.yaml"
    prefix: /%sylius_admin.path_name%

Update App\Entity\Shipping\ShippingMethod to implements ColishipShippingMethodInterface and use ColishipShippingMethodTrait.

Update App\Entity\Addressing\Address to implements ColishipAddressInterface and use ColishipAddressTrait.

Finally, update your database schema :

bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate

Contributing

You can find a way to run the plugin without effort in the file DEVELOPMENT.md.

Then you can open an issue or a Pull Request if you want! 😘
Thank you!

License

This plugin is completely free and released under the MIT License.