README.md 2.05 KB
Newer Older
Alexander Wink's avatar
Alexander Wink committed
1
# CrefoPay Shopware 6 Plugin
2

Daniel Kazior's avatar
Daniel Kazior committed
3 4
## Introduction

Monique Gottschalk's avatar
Monique Gottschalk committed
5 6 7 8 9
Before using the module for Shopware 6, bear in mind that it is in open BETA status. 
This means that the plugin is tested and functional in the basic functionalities, but there may still be minor errors. 
We therefore recommend that you first install and test the plugin on a staging environment before taking it live.  
Nevertheless, the plugin is already being used successfully in the shop by some retailers and we are currently actively 
working on bringing the plugin into the official Shopware 6 store in the near future.
Daniel Kazior's avatar
Daniel Kazior committed
10

11 12 13
## Productive template installation via git
* Checkout this repository to `custom/plugins/CrefoPay`
* Run `composer install --no-dev` inside the plugin directory
14
* Install and activate the plugin via plugin manager
15
* Build administration and storefront (`./bin/build-storefront.sh && ./bin/build-administration.sh`)
16
* Compile themes (`./bin/console theme:compile`)
17 18 19 20

## Development template installation via git
* Checkout this repository to `custom/plugins/CrefoPay`
* Run `composer install` inside the plugin directory
21
* Install and activate the plugin via plugin manager
22 23
* Build administration and storefront (`./psh.phar storefront:build && ./psh.phar administration:build`)

24 25 26 27
## Workflow
### Notifications
Notifications can be executed by running the following command `./bin/console messenger:consume default` inside your shop directory or accessing the administration

28 29 30 31 32 33 34 35
## Tests
### Cypress
To run the implemented cypress tests you need to install the dependencies via `npm install` inside the plugin directory.
You also need to copy the `cypress.json.dist` to `cypress.json` and adjust the `baseUrl`.

After that you can simply execute 
* `npm run cypress:open` to select (and watch) tests one by one
* `npm run cypress:run` for automatic execution
36
* If there are any errors a new directory will show up with screenshots of the problem
Daniel Kazior's avatar
Daniel Kazior committed
37

Daniel Kazior's avatar
Daniel Kazior committed
38
## Incompatibilities
Daniel Kazior's avatar
Daniel Kazior committed
39 40 41

The following modules have been detected as currently not compatible with CrefoPay Payment Plugin:
* https://store.shopware.com/pdwe376783495436/sticky-menu.html