Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 4.51 KB

README.md

File metadata and controls

108 lines (76 loc) · 4.51 KB
Raw

OXID eShop TeleCash Module

Development Latest Version PHP Version

Quality Gate Status Coverage Technical Debt

Payment-Module for Payment-Provider Telecash.

Branch compatibility

  • b-7.1.x branch / v1.x version - compatible with OXID eShop compilation 7.1.x and the respective branch

Twig only! (eg. no Smarty Support anymore)

Installation

  • ...
  • ...

Development (local Docker environment)

You'll need:

  • Github Token (Replace <YOUR TOKEN HERE> with your token)
  • Github Username + Password (will be asked during installation. You can use the same token again)
  • Docker

! Note: This approach is partly based on private OXID recipes, which are accessible only by OXID staff, or if you were granted permission !

For the initial setup of the development environment, you can use the following command:

echo telecash && git clone https://github.com/OXID-eSales/docker-eshop-sdk.git $_ && cd $_ && \ 
git clone https://<YOUR TOKEN HERE>@github.com/OXID-eSales/docker-eshop-sdk-osc-private-recipes recipes/oxid-esales-private && \ 
chmod +x ./recipes/oxid-esales-private/module-telecash/b-7.1.x-ee-telecash-twig-dev/run.sh && \ 
./recipes/oxid-esales-private/module-telecash/b-7.1.x-ee-telecash-twig-dev/run.sh

This will create a folder telecash in your current directory, compile and start the Docker containers, and run the Shop v7.1 Setup. A demo database will be installed and the shop is configured to run on https://localhost.local.

You might need a new entry in your hosts file to route this domain:

127.0.0.1 localhost.local

An admin account will be created: noreply@oxid-esales.com / admin

Install and try it out

This module is in working state and can be directly installed via composer:

composer require oxid-solution-catalysts/telecash-module
./vendor/bin/oe-eshop-doctrine_migration migrations:migrate osc_telecash

and activate the module.

Running tests and quality tools

Check the scripts section in the composer.json of the module to get more insight of preconfigured quality tools available. Example:

$ composer phpcs
$ composer phpstan
$ composer phpmd

Integration/Acceptance tests

  • install this module into a running OXID eShop
  • run composer update in module root directory
$ cd vendor/oxid-solution-catalysts/telecash-module
$ composer update

After this done, check the "scripts" section of module composer.json file to see how we run tests.

$ composer tests-unit
$ composer tests-integration
$ composer tests-codeception

NOTE: From OXID eShop 7.0.x on database reset needs to be done with this command (please fill in your credentials)

$ bin/oe-console oe:database:reset --db-host=mysql --db-port=3306 --db-name=example --db-user=root --db-password=root --force

Contact us

In case you have any complaints, suggestions, business cases you'd like an example for please contact us. Pull request are also welcome. Every feedback we get will help us improve.

Kudos