Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oberonamsterdam/clinchpad-api-php
Wrapper for ClinchPad API
https://github.com/oberonamsterdam/clinchpad-api-php
Last synced: 4 days ago
JSON representation
Wrapper for ClinchPad API
- Host: GitHub
- URL: https://github.com/oberonamsterdam/clinchpad-api-php
- Owner: oberonamsterdam
- License: mit
- Created: 2019-08-20T11:46:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-15T10:17:35.000Z (over 4 years ago)
- Last Synced: 2024-11-20T21:42:31.673Z (2 months ago)
- Language: PHP
- Size: 45.9 KB
- Stars: 1
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP library for v1 of the ClinchPad API
This library provides convenient wrapper functions for ClinchPad's REST API.
The API is [documented here](https://clinchpad.com/api/docs/).## Requirements
- PHP 5.4.0 or greater (7.0 or greater if you wish to use phpunit)
- [Composer](https://getcomposer.org/)
- [Guzzle](https://github.com/guzzle/guzzle)## Installation
Dependencies are managed by [Composer](https://getcomposer.org/). After
installing Composer, run the following command from the library root:`composer install --no-dev --ignore-platform-reqs`
Or to install with phpunit:
`composer install`
## Testing
This library includes a [PHPUnit](https://phpunit.de/) test suite.
### Running PHPUnit tests
Add Composer's vendor directory to your PATH by adding the following line to
your profile. This is dependent on your system, but on a Linux or Mac OSX system
using Bash, you'll typically find the file at *~/.bash_profile*.`export PATH="./vendor/bin:$PATH"`
Bash example:
```shell
echo 'export PATH="./vendor/bin:$PATH"' >> ~/.bash_profile
source ~/.bash_profile
```Then run PHPUnit:
`phpunit`