hdk-pay/README.md

# HDK-Pay

A sdk to connect to LuxPay.

## PHP Versions

This version will work on PHP version 8.0 and above.

## Getting Started

PHP 8.0 or above and Composer is expected to be installed on our system.

### Installing

```bash
composer require singularity/hdk-pay
```

This will install all dependencies needed for the project.

### Configurations

You need to add an item `http_request.pay.rpc_base_uri` in *config/autoload/common.php*.
Usually, the value of this item will be *https://pay.luxcreo.cn* or *https://test-pay.luxcreo.cn*.
**Don't need the following `/`**.

## Running the Tests

All tests can be run by executing

```bash
vendor/bin/phpunit
```

`phpunit` will automatically find all tests inside the `test` directory and run them based on the configuration in the `phpunit.xml` file.

### Testing Approach

The test for the class `Greeting` verifies that the return value of the `sayHello` method returns the string "Hello {name}", where {name} is the value passed through to the constructor.

## Running the Application

PHP has an in-built server for local development. This can be started by executing

```
php -S localhost:8000 -t public
```

Then open your browser at `http://localhost:8000/example.php`

You should see the text "Hello Ada Lovelace" on your screen.

## Built With

  - [PHP](https://secure.php.net/)
  - [Composer](https://getcomposer.org/)
  - [PHPUnit](https://phpunit.de/)

## License

This project is licensed under the MIT License - see the [LICENCE.md](LICENCE.md) file for details.