https://github.com/oxid-esales/paypal-subscriptions-module
PayPal subscriptions module
https://github.com/oxid-esales/paypal-subscriptions-module
Last synced: 3 months ago
JSON representation
PayPal subscriptions module
- Host: GitHub
- URL: https://github.com/oxid-esales/paypal-subscriptions-module
- Owner: OXID-eSales
- License: gpl-3.0
- Created: 2022-05-03T09:57:56.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-03T10:52:42.000Z (about 4 years ago)
- Last Synced: 2025-01-01T01:26:42.386Z (over 1 year ago)
- Language: PHP
- Size: 411 KB
- Stars: 1
- Watchers: 13
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PayPal Checkout for OXID
PayPal checkout integration for OXID eShop 6.2 and above.
## Documentation
* official german PayPal checkout for OXID [Documentation](https://docs.oxid-esales.com/modules/paypal-checkout/de/latest/).
* official english PayPal checkout for OXID [Documentation](https://docs.oxid-esales.com/modules/paypal-checkout/en/latest/).
## Branch Compatibility
* b-6.3.x module branch is compatible with OXID eShop compilation 6.2
## Install
```bash
# Add Repositories source
$ composer config repositories.oscpaypal composer https://paypal-module.packages.oxid-esales.com/
# Install desired version of oxid-solution-catalysts/paypal module
$ composer require oxid-solution-catalysts/paypal-module ^1.0.0
# Run install
$ composer install
# Activate the module
$ ./vendor/bin/oe-console oe:module:install-configuration source/modules/osc/paypal
$ ./vendor/bin/oe-console oe:module:apply-configuration
```
**NOTE:** The location of the oe-console script depends on whether your root package
is the oxideshop_ce (```./bin/oe-console```) or if the shop was installed from
an OXID eShop edition metapackage (```./vendor/bin/oe-console```).
After requiring the module, you need to activate it, either via OXID eShop admin or CLI.
```bash
$ ./vendor/bin/oe-console oe:module:activate osc_paypal
```
## Limitations
* no limitations
## Running tests
Warning: Running tests will reset the shop.
#### Requirements:
* Ensure test_config.yml is configured:
* ```
partial_module_paths: osc/paypal
```
* ```
activate_all_modules: true
run_tests_for_shop: false
run_tests_for_modules: true
```
* For codeception tests to be running, selenium server should be available, several options to solve this:
* Use OXID official [vagrant box environment](https://github.com/OXID-eSales/oxvm_eshop).
* Use OXID official [docker sdk configuration](https://github.com/OXID-eSales/docker-eshop-sdk).
* Use other preconfigured containers, example: ``image: 'selenium/standalone-chrome-debug:3.141.59'``
#### Run
Running phpunit tests:
```
vendor/bin/runtests
```
Running phpunit tests with coverage reports (report is generated in ``.../paypal/Tests/reports/`` directory):
```
XDEBUG_MODE=coverage vendor/bin/runtests-coverage
```
Running codeception tests default way (Host: selenium, browser: chrome):
```
vendor/bin/runtests-codeception
```
Running codeception tests example with specific host/browser/testgroup:
```
SELENIUM_SERVER_HOST=seleniumchrome BROWSER_NAME=chrome vendor/bin/runtests-codeception --group=examplegroup
```