Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oxid-esales/telecash-module

Last synced: about 1 month 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 (3 months ago)
Default Branch: b-7.1.x
Last Pushed: 2024-11-05T15:17:41.000Z (about 2 months ago)
Last Synced: 2024-11-05T16:29:08.752Z (about 2 months 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

[![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)
[![Latest Version](https://img.shields.io/packagist/v/OXID-eSales/telecash-module?logo=composer&label=latest&include_prereleases&color=orange)](https://packagist.org/packages/oxid-esales/telecash-module)
[![PHP Version](https://img.shields.io/packagist/php-v/oxid-esales/telecash-module)](https://github.com/oxid-esales/telecash-module)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_telecash-module&metric=alert_status)](https://sonarcloud.io/dashboard?id=OXID-eSales_telecash-module)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_telecash-module&metric=coverage)](https://sonarcloud.io/dashboard?id=OXID-eSales_telecash-module)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_telecash-module&metric=sqale_index)](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: `[email protected] / 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
```

### 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 ([email protected]) from Checkdomain GmbH for his API client, which we use as a base for our development.

https://github.com/checkdomain/TeleCash/tree/master