Skip to content

Commit 7607fef

Browse files
committed
add dev requirements and update readme for packagist installation
1 parent 3837ad0 commit 7607fef

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,20 @@ admin order mail.
2828

2929
### Module installation via composer
3030

31+
#### Default installation via packagist (recommend)
32+
* add the module to your shop composer.json
33+
* `composer require patrick-blom/multi-ordermail-receiver`
34+
35+
#### Alternative installation via GitHub (manual)
3136
* create a new folder called "thirdparty" with the subfolder "pb" at the shop root level (same level as the composer.json)
3237
* `cd <shop root>`
3338
* `mkdir -p thirdparty/pb`
3439
* clone the repository to the new folder
3540
* `git clone [email protected]:patrick-blom/multi-ordermail-receiver.git thirdparty/pb/MultiOrderMailReceiver`
3641
* navigate back to the shop root level and add the repository to composer.json
3742
* `composer config repositories.patrick-blom/multi-ordermail-receiver path thirdparty/pb/MultiOrderMailReceiver`
38-
* add the module to your shop composer.json
39-
* `composer require patrick-blom/multi-ordermail-receiver`
43+
44+
#### OXID eShop module activation (identical for default && alternative installation)
4045
* prepare the module configuration for eShop 6.2
4146
* `vendor/bin/oe-console oe:module:install-configuration source/modules/pb/MultiOrderMailReceiver/`
4247
* `vendor/bin/oe-console oe:module:apply-configuration`
@@ -64,7 +69,7 @@ The testing process should only be done in a development environment or CI pipel
6469
* Prepare the [OXID Testing Library](https://github.com/OXID-eSales/testing_library) likes described in their repository
6570
or use the [oxvm_eshop](https://github.com/OXID-eSales/oxvm_eshop) / [docker-eshop-sdk](https://github.com/OXID-eSales/docker-eshop-sdk)
6671
* Add `pb/MultiOrderMailReceiver` to the partial module paths in your test_config.yml (e.g: `partial_module_paths: 'pb/MultiOrderMailReceiver'`)
67-
* Copy the `config.inc.TEST.php.dist` to your shop root and rename it to `config.inc.TEST.php`
72+
* Copy the `config.inc.TEST.php.dist` from the vendor module directory to your shop root and rename it to `config.inc.TEST.php`
6873
* Adjust the settings in the `config.inc.TEST.php` to your needs (test database name, error reporting, etc)
6974
* Modify your `config.inc.php` and ensure that the `config.inc.TEST.php` will be loaded during the tests
7075
```php

composer.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "patrick-blom/multi-ordermail-receiver",
33
"description": "This is a module for the OXID eShop which extends the amount of admin order mail receivers.",
44
"type": "oxideshop-module",
5-
"keywords": ["oxid", "modules", "eShop", "emails", "order"],
5+
"keywords": ["oxid", "module", "eShop", "emails", "order", "admin","carbon copy"],
66
"homepage": "https://www.patrick-blom.de/",
77
"version": "1.0",
88
"license": [
@@ -18,7 +18,11 @@
1818
}
1919
},
2020
"require": {
21-
"php": ">=7.1"
21+
"php": ">=7.1",
22+
"oxid-esales/oxideshop-ce": "^v6.5.3"
23+
},
24+
"require-dev": {
25+
"oxid-esales/testing-library": "^v7.1.0"
2226
},
2327
"autoload": {
2428
"psr-4": {

0 commit comments

Comments
 (0)