Skip to content

Commit

Permalink
README improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Zales0123 committed Oct 23, 2023
1 parent 64fd398 commit 447eeec
Show file tree
Hide file tree
Showing 15 changed files with 107 additions and 42 deletions.
97 changes: 91 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,111 @@
![Build Status](https://github.com/CommerceWeavers/SyliusSaferpayPlugin/actions/workflows/build.yaml/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This plugin adds integration with [Wordline Saferpay](https://www.saferpay.com) to [Sylius](https://github.com/Sylius/Sylius).
![Sylius](docs/img/sylius.png) ![Wordline](docs/img/wordline.png)

## Content

1. [Requirements](docs/requirements.md)
1. [Requirements](#requirements)
1. [Overview](#overview)
1. [Features](#features)
1. [Installation](docs/installation.md)
1. [Configuration](docs/configuration.md)
1. [Development](docs/development.md)
1. [Testing](docs/testing.md)
1. [Cooperation](#cooperation)
1. [License](#license)
1. [About us](#about-us)

### Requirements

| Package | Version |
|---------------|---------|
| PHP | ^8.0 |
| sylius/sylius | ^1.10.0 |

### Overview

This plugin adds integration with [Wordline Saferpay](https://www.saferpay.com) to [Sylius](https://github.com/Sylius/Sylius).

#### About Saferpay

Saferpay is a modern, all-in-one payment solution, particularly popular in the DACH region due to origins of its
previous owner - SIX Payments - which is a Swiss fintech acquired by French Wordline group. As part of Wordline group,
Saferpay now offers integrations with all major payment methods, incl. local ones like TWINT, major card operators
(VISA, Mastercard), and globally used wallets like ApplePay, GooglePay, PayPal, etc.

- Free of charge activation of all major means of payment
- Individual payment pages
- Mail-/Phone-Order payments
- Creation and sending of individual payment links
- Acceptance of mobile payments using QR codes
- Payment API & Management API for automation of payments
- Saferpay Backoffice for a complete overview
- Saferpay Risk Management & User Administration
- Saferpay Plugins available for your shop system
- Highest security standards thanks to PCI DSS, PSD2 and 3-D Secure 2
- Dynamic currency conversion DCC: your international customers pay in their local currency

### Features

- Saferpay payment method configuration (both test and live environments)
- Payment method transaction logs
- "Debug" mode that allows to log all the logs not only error/failed ones
- Configuration panel to filter which payments should be used with Saferpay
- Webhooks integration for authorization, capture and cancellation
- Refunds with default Sylius refunding process (RefundPlugin integration in the future)

Checkout:

![Payments checkout](docs/img/overview/payments-checkout.png)
![Payment logos](docs/img/overview/payment-logos.png)

Configured Saferpay payment method:

![Index](docs/img/overview/payment-methods.png)
![Edit](docs/img/overview/edit-form.png)
![Configuration](docs/img/overview/payment-methods-configuration.png)

Payments logs:

![Logs](docs/img/overview/logs.png)

Saferpay panel:

![Saferpay panel](docs/img/overview/panel.png)

### Cooperation

This plugin was developed in cooperation with [WTG](https://www.wtg.com/) Team. Thank you!
This plugin was sponsored by [WTG Innovation](https://www.wtg.com/innovation) and developed in cooperation
with their Team. Thank you for your contribution to the open-source ecosystem!

![WTG](docs/img/wtg.png)

### License

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

### Security

If you find anything that could be a security problem, please reach us first on [email protected]
in order to prepare a patch before disclosure.

### Support

As plugin creators, we will be happy to help you implement it in your system and maintain it later on.
If you wish to use the free-of-charge community support, make sure to join the [Sylius Slack](https://sylius-community.slack.com/).
We encourage you to use the official Sylius resources to feel more confident in using this plugin:

- [Sylius Documentation](https://docs.sylius.com/en/latest/)
- [Sylius Online Course](https://sylius.com/online-course/)
- [Sylius Stack Overflow](https://stackoverflow.com/questions/tagged/sylius)

### About us

We are [Commerce Weavers](https://www.commerceweavers.com/). For years, we have been [Sylius](https://github.com/Sylius/Sylius) e-commerce framework maintainers
and open-source community leaders. Within this time we have developed our careers and grown fond of each other.
Finally, we have decided to form a new company together. Read more about it in [this article](https://www.linkedin.com/pulse/we-commerce-weavers-commerce-weavers/).
- [Commerce Weavers](https://www.commerceweavers.com/) are the web agency formed by ex-Sylius company members, and long-term core team & community leaders of Sylius - the open-source e-commerce framework based on Symfony, PHP.
- With these origins, we naturally provide services related to all above mentioned technologies - using Sylius, Symfony, and API Platform for various applications development and maintenance.
- We also actively contribute to the open-source community by creating dedicated plugins and visiting tech events.
- We are probably the most active company promoting Sylius on industry meetups - our speakers can be frequently seen at the stages of the biggest PHP & Symfony conferences throught Europe, and beyond.
- In need of training or consulting? We love knowledge sharing and have a proven track record of over 200 trained developers all over Europe. [Get in touch!](https://www.commerceweavers.com/#contact)

![Commerce Weavers](docs/img/cw.png)
6 changes: 6 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ After you successfully create an account and log in, you can move forward to its

![Sylius payment method configuration](./img/6-pm-configuration.png)

7. Beware! By defaults after payment methods creation there is no payment method enabled for the payment. To configure it
go to the `/admin/payment-methods/{id}/configure-saferpay-payment-methods` URL and check out which payment methods you would
like to use.

![Payment methods configuration](./img/overview/payment-methods-configuration.png)

Done! You're now ready to use Saferpay payment method in your webshop 🎉

---
Expand Down
2 changes: 1 addition & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Development

```bash
git clone [email protected]:Sylius/PayPalPlugin.git
git clone [email protected]:CommerceWeavers/SyliusSaferpayPlugin.git
(cd tests/Application && yarn install)
(cd tests/Application && yarn build)
(cd tests/Application && bin/console assets:install)
Expand Down
Binary file modified docs/img/cw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/overview/edit-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/overview/logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/overview/panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/overview/payment-logos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/overview/payment-methods.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/overview/payments-checkout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/sylius.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/wordline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 0 additions & 10 deletions docs/requirements.md

This file was deleted.

34 changes: 9 additions & 25 deletions symfony.lock
Original file line number Diff line number Diff line change
Expand Up @@ -85,19 +85,6 @@
"knplabs/knp-menu-bundle": {
"version": "v3.2.0"
},
"league/flysystem-bundle": {
"version": "2.4",
"recipe": {
"repo": "github.com/symfony/recipes",
"branch": "main",
"version": "1.0",
"ref": "913dc3d7a5a1af0d2b044c5ac3a16e2f851d7380"
},
"files": [
"config/packages/flysystem.yaml",
"var/storage/.gitignore"
]
},
"lexik/jwt-authentication-bundle": {
"version": "2.17",
"recipe": {
Expand Down Expand Up @@ -140,6 +127,15 @@
"ref": "518ac22defa04a8a1d82479ed362e2921487adf0"
}
},
"phpstan/phpstan": {
"version": "1.10",
"recipe": {
"repo": "github.com/symfony/recipes-contrib",
"branch": "main",
"version": "1.0",
"ref": "5e490cc197fb6bb1ae22e5abbc531ddc633b6767"
}
},
"phpunit/phpunit": {
"version": "9.6",
"recipe": {
Expand Down Expand Up @@ -293,18 +289,6 @@
"config/packages/lock.yaml"
]
},
"symfony/mailer": {
"version": "5.4",
"recipe": {
"repo": "github.com/symfony/recipes",
"branch": "main",
"version": "4.3",
"ref": "2bf89438209656b85b9a49238c4467bff1b1f939"
},
"files": [
"config/packages/mailer.yaml"
]
},
"symfony/messenger": {
"version": "6.0",
"recipe": {
Expand Down

0 comments on commit 447eeec

Please sign in to comment.