eko54r
b5e3a778ce
All checks were successful
Build, Push and Deploy / build-and-push (push) Successful in 3m3s
Gitea Actions Demo / Explore-Gitea-Actions (push) Successful in 16s
Build, Push and Deploy / deploy-staging (push) Successful in 32s
Build, Push and Deploy / deploy-production (push) Has been skipped
Build, Push and Deploy / cleanup (push) Successful in 1s
70 lines
1.8 KiB
Markdown
70 lines
1.8 KiB
Markdown
# FedaPay PHP [](https://travis-ci.org/fedapay/fedapay-php)
|
|
|
|
You can sign up for a FedaPay account at https://fedapay.com.
|
|
|
|
## Requirements
|
|
|
|
PHP 5.5 and later.
|
|
|
|
## Composer
|
|
|
|
You can install the bindings via [Composer](http://getcomposer.org/). Run the following command:
|
|
|
|
```bash
|
|
composer require fedapay/fedapay-php
|
|
```
|
|
|
|
To use the bindings, use Composer's [autoload](https://getcomposer.org/doc/00-intro.md#autoloading):
|
|
|
|
```php
|
|
require_once('vendor/autoload.php');
|
|
```
|
|
|
|
## Manual Installation
|
|
|
|
If you do not wish to use Composer, you can download the [latest release](https://github.com/fedapay/fedapay-php/releases). Then, to use the bindings, include the `init.php` file.
|
|
|
|
```php
|
|
require_once('/path/to/fedapay-php/init.php');
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
The bindings require the following extension in order to work properly:
|
|
|
|
- [`curl`](https://secure.php.net/manual/en/book.curl.php), although you can use your own non-cURL client if you prefer
|
|
- [`json`](https://secure.php.net/manual/en/book.json.php)
|
|
- [`mbstring`](https://secure.php.net/manual/en/book.mbstring.php) (Multibyte String)
|
|
|
|
If you use Composer, these dependencies should be handled automatically. If you install manually, you'll want to make sure that these extensions are available.
|
|
|
|
## Getting Started
|
|
|
|
Simple usage looks like:
|
|
|
|
## Documentation
|
|
|
|
Please see https://docs.fedapay.com/development/api for up-to-date documentation.
|
|
|
|
## Development
|
|
|
|
Install dependencies:
|
|
|
|
``` bash
|
|
composer install
|
|
```
|
|
|
|
## Tests
|
|
|
|
Install dependencies as mentioned above (which will resolve [PHPUnit](http://packagist.org/packages/phpunit/phpunit)), then you can run the test suite:
|
|
|
|
```bash
|
|
./vendor/bin/phpunit
|
|
```
|
|
|
|
Or to run an individual test file:
|
|
|
|
```bash
|
|
./vendor/bin/phpunit tests/UtilTest.php
|
|
```
|