{"id":18948368,"url":"https://github.com/oxid-esales/telecash-module","last_synced_at":"2025-08-04T23:18:27.565Z","repository":{"id":259420116,"uuid":"858621463","full_name":"OXID-eSales/telecash-module","owner":"OXID-eSales","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-05T15:17:41.000Z","size":1852,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":7,"default_branch":"b-7.1.x","last_synced_at":"2024-11-05T16:29:08.752Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OXID-eSales.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-17T08:31:24.000Z","updated_at":"2024-11-05T15:07:20.000Z","dependencies_parsed_at":"2024-10-25T12:47:10.519Z","dependency_job_id":null,"html_url":"https://github.com/OXID-eSales/telecash-module","commit_stats":null,"previous_names":["oxid-esales/telecash-module"],"tags_count":0,"template":false,"template_full_name":"OXID-eSales/module-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Ftelecash-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Ftelecash-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Ftelecash-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Ftelecash-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OXID-eSales","download_url":"https://codeload.github.com/OXID-eSales/telecash-module/tar.gz/refs/heads/b-7.1.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223688674,"owners_count":17186298,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T13:13:20.732Z","updated_at":"2025-04-15T23:30:48.106Z","avatar_url":"https://github.com/OXID-eSales.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OXID eShop TeleCash Module\n\n[![Development](https://github.com/OXID-eSales/telecash-module/actions/workflows/trigger.yaml/badge.svg?branch=b-7.1.x)](https://github.com/OXID-eSales/telecash-module/actions/workflows/trigger.yaml)\n[![Latest Version](https://img.shields.io/packagist/v/OXID-eSales/telecash-module?logo=composer\u0026label=latest\u0026include_prereleases\u0026color=orange)](https://packagist.org/packages/oxid-esales/telecash-module)\n[![PHP Version](https://img.shields.io/packagist/php-v/oxid-esales/telecash-module)](https://github.com/oxid-esales/telecash-module)\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_telecash-module\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=OXID-eSales_telecash-module)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_telecash-module\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=OXID-eSales_telecash-module)\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_telecash-module\u0026metric=sqale_index)](https://sonarcloud.io/dashboard?id=OXID-eSales_telecash-module)\n\n\nPayment-Module for Payment-Provider Telecash.\n\n## Branch compatibility\n\n* b-7.1.x branch / v1.x version - compatible with OXID eShop compilation 7.1.x and the respective branch\n\nTwig only! (eg. no Smarty Support anymore)\n\n## Installation\n\n* ...\n* ... \n\n### Development (local Docker environment)\nYou'll need: \n- Github Token (Replace `\u003cYOUR TOKEN HERE\u003e` with your token)\n- Github Username + Password (will be asked during installation. You can use the same token again)\n- Docker\n\n! Note: This approach is partly based on private OXID recipes, \nwhich are accessible only by OXID staff, or if you were granted permission ! \n\nFor the initial setup of the development environment, you can use the following command:\u003cbr\u003e\n```\necho telecash \u0026\u0026 git clone https://github.com/OXID-eSales/docker-eshop-sdk.git $_ \u0026\u0026 cd $_ \u0026\u0026 \\ \ngit clone https://\u003cYOUR TOKEN HERE\u003e@github.com/OXID-eSales/docker-eshop-sdk-osc-private-recipes recipes/oxid-esales-private \u0026\u0026 \\ \nchmod +x ./recipes/oxid-esales-private/module-telecash/b-7.1.x-ee-telecash-twig-dev/run.sh \u0026\u0026 \\ \n./recipes/oxid-esales-private/module-telecash/b-7.1.x-ee-telecash-twig-dev/run.sh\n```\nThis will create a folder `telecash` in your current directory, compile and start the Docker containers, and run the Shop v7.1 Setup.\nA demo database will be installed and the shop is configured to run on `https://localhost.local`.\n\nYou might need a new entry in your `hosts` file to route this domain:\n```\n127.0.0.1 localhost.local\n```\n\nAn admin account will be created: `noreply@oxid-esales.com / admin`\n\n### Install and try it out\n\nThis module is in working state and can be directly installed via composer:\n```\ncomposer require oxid-solution-catalysts/telecash-module\n./vendor/bin/oe-eshop-doctrine_migration migrations:migrate osc_telecash\n```\n\nand [activate the module](https://docs.oxid-esales.com/developer/en/latest/development/modules_components_themes/module/installation_setup/setup.html#setup-activation).\n\n\n## Running tests and quality tools\n\nCheck the ``scripts`` section in the composer.json of the module to get more insight of\npreconfigured quality tools available. Example:\n\n```bash\n$ composer phpcs\n$ composer phpstan\n$ composer phpmd\n```\n\n### Integration/Acceptance tests\n\n- install this module into a running OXID eShop\n- run `composer update` in module root directory\n\n```bash\n$ cd vendor/oxid-solution-catalysts/telecash-module\n$ composer update\n```\n\nAfter this done, check the \"scripts\" section of module `composer.json` file to see how we run tests.\n\n```bash\n$ composer tests-unit\n$ composer tests-integration\n$ composer tests-codeception\n```\n\nNOTE: From OXID eShop 7.0.x on database reset needs to be done with this command (please fill in your credentials)\n\n```bash\n$ bin/oe-console oe:database:reset --db-host=mysql --db-port=3306 --db-name=example --db-user=root --db-password=root --force\n```\n\n### Cypress e2e Tests\n\n* add cypress.yaml to your docker-compose.yaml:\n```yaml\n  cypress:\n    image: cypress/included:latest\n    working_dir: /var/www/extensions/telecash/tests/e2e\n    volumes:\n      - ./source/extensions/telecash:/var/www/extensions/telecash:cached\n      - /tmp/.X11-unix:/tmp/.X11-unix\n    environment:\n      - CYPRESS_baseUrl=https://oxidshop.local\n    ports:\n      - \"5920:5900\" # VNC port\n    command: cypress open\n    depends_on:\n      apache:\n        condition: service_started\n      php:\n        condition: service_started\n    entrypoint: [ \"npx\", \"cypress\", \"run\", \"--config-file\", \"/var/www/vendor/oxid-solution-catalysts/telecash-module/tests/e2e/cypress.config.js\" ]\n\n```\nThen run\n```bash\n  docker compose up cypress\n```\n\n### Cypress e2e Tests to run from shell script on GHA\n\nRun 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:\n\n```bash\n  ./source/vendor/oxid-solution-catalysts/telecash-module/.github/oxid-esales/cypress.sh\n```\n\n### Contact us\n\n* In case of issues / bugs, use \"Issues\" section on github, to report the problem.\n* [Join our community forum](https://forum.oxid-esales.com/)\n* [Use the contact form](https://www.oxid-esales.com/en/contact/contact-us.html)\n\nIn case you have any complaints, suggestions, business cases you'd like an example for\nplease contact us. Pull request are also welcome.  Every feedback we get will help us improve.\n\n### Kudos\n- Torsten Petersdorf (t.petersdorf@checkdomain.de) from Checkdomain GmbH for his API client, which we use as a base for our development.\u003cbr\u003e\n  https://github.com/checkdomain/TeleCash/tree/master\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxid-esales%2Ftelecash-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxid-esales%2Ftelecash-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxid-esales%2Ftelecash-module/lists"}