Skip to content

Latest commit

 

History

History
135 lines (88 loc) · 4.24 KB

README.md

File metadata and controls

135 lines (88 loc) · 4.24 KB
Raw

Sylius Checkout Plugin

Support

Table of Content

Overview

This plugin allows you to use checkout.com to receive credit card payments on your e-commerce website.

Installation

Install the plugin with composer:

$ composer require sherlockode/sylius-checkout-plugin

If your project does not use autoload, you have to enable the bundle yourself:

// config/bundle.php

return [
    ...
    
    Sherlockode\SyliusCheckoutPlugin\SherlockodeSyliusCheckoutPlugin::class => ['all' => true],
];

Configuration

Update your sylius installation by importing bundle configuration:

# config/packages/_sylius.yaml

imports:
    # ...

    - { resource: "@SherlockodeSyliusCheckoutPlugin/Resources/config/config.yaml" }

Then import routes:

# config/routes.yaml

sherlockode_sylius_checkout_plugin:
    resource: "@SherlockodeSyliusCheckoutPlugin/Resources/config/routing.xml"

Update your webpack configuration to add an entry in shop config:

// Shop config
Encore
    // ...
    .addEntry('sherlockode-checkout', './vendor/sherlockode/sylius-checkout-plugin/src/Resources/public/js/entry.js')

Usage

Payment method configuration

Now you only have to create a new payment method based on the Checkout.com type, then fill your credentials in the gateway configuration.

image

Demo Sylius Shop

We created a demo app with some useful use-cases of plugins! Visit sylius-demo.sherlockode.fr to take a look at it. The admin can be accessed under sylius-demo.sherlockode.fr/admin/login link. Plugins that we have used in the demo:

Plugin name GitHub Sylius' Store
Advance Content Bundle (ACB) https://github.com/sherlockode/SyliusAdvancedContentPlugin -
Mondial Relay https://github.com/sherlockode/SyliusMondialRelayPlugin -
Checkout Plugin https://github.com/sherlockode/SyliusCheckoutPlugin -
FAQ https://github.com/sherlockode/SyliusFAQPlugin -

Additional resources for developers

To learn more about our contribution workflow and more, we encourage you to use the following resources:

License

This plugin's source code is completely free and released under the terms of the MIT license.

Contact

If you want to contact us, the best way is to fill the form on our website or send us an e-mail to [email protected] with your question(s). We guarantee that we answer as soon as we can!