https://github.com/oxid-esales/telecash-module
https://github.com/oxid-esales/telecash-module
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/oxid-esales/telecash-module
- Owner: OXID-eSales
- License: other
- Created: 2024-09-17T08:31:24.000Z (almost 2 years ago)
- Default Branch: b-7.1.x
- Last Pushed: 2024-11-05T15:17:41.000Z (over 1 year ago)
- Last Synced: 2024-11-05T16:29:08.752Z (over 1 year ago)
- Language: PHP
- Size: 1.77 MB
- Stars: 2
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# OXID eShop TeleCash Module
[](https://github.com/OXID-eSales/telecash-module/actions/workflows/trigger.yaml)
[](https://packagist.org/packages/oxid-esales/telecash-module)
[](https://github.com/oxid-esales/telecash-module)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_telecash-module)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_telecash-module)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_telecash-module)
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 `` 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://@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](https://docs.oxid-esales.com/developer/en/latest/development/modules_components_themes/module/installation_setup/setup.html#setup-activation).
## 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:
```bash
$ composer phpcs
$ composer phpstan
$ composer phpmd
```
### Integration/Acceptance tests
- install this module into a running OXID eShop
- run `composer update` in module root directory
```bash
$ 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.
```bash
$ 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)
```bash
$ bin/oe-console oe:database:reset --db-host=mysql --db-port=3306 --db-name=example --db-user=root --db-password=root --force
```
### Cypress e2e Tests
* add cypress.yaml to your docker-compose.yaml:
```yaml
cypress:
image: cypress/included:latest
working_dir: /var/www/extensions/telecash/tests/e2e
volumes:
- ./source/extensions/telecash:/var/www/extensions/telecash:cached
- /tmp/.X11-unix:/tmp/.X11-unix
environment:
- CYPRESS_baseUrl=https://oxidshop.local
ports:
- "5920:5900" # VNC port
command: cypress open
depends_on:
apache:
condition: service_started
php:
condition: service_started
entrypoint: [ "npx", "cypress", "run", "--config-file", "/var/www/vendor/oxid-solution-catalysts/telecash-module/tests/e2e/cypress.config.js" ]
```
Then run
```bash
docker compose up cypress
```
### Cypress e2e Tests to run from shell script on GHA
Run shell script from the host, from the same . where docker-compose.yml is located on the host or on the github with the following command:
```bash
./source/vendor/oxid-solution-catalysts/telecash-module/.github/oxid-esales/cypress.sh
```
### Contact us
* In case of issues / bugs, use "Issues" section on github, to report the problem.
* [Join our community forum](https://forum.oxid-esales.com/)
* [Use the contact form](https://www.oxid-esales.com/en/contact/contact-us.html)
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
- Torsten Petersdorf (t.petersdorf@checkdomain.de) from Checkdomain GmbH for his API client, which we use as a base for our development.
https://github.com/checkdomain/TeleCash/tree/master