Skip to content

Commit f6b2cdc

Browse files
committed
- Composer setup - Basic setup - Updated readme
1 parent 3c2b30f commit f6b2cdc

14 files changed

Lines changed: 2450 additions & 0 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/vendor/
2+
.env

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
1+
[![Packagist](https://img.shields.io/packagist/v/BekoDesign/versioAPI.svg)]()
2+
13
# Versio-PHP-API
24
PHP implementation of the new Restfull Versio API (https://www.versio.nl/RESTapidoc/)
5+
6+
## Installation
7+
8+
### Composer (recommended)
9+
10+
Installation through composer:
11+
````
12+
composer require BekoDesign\VersioAPI
13+
````
14+
15+
**@Todo:** Submit project to composer
16+
17+
### Alternative
18+
19+
Download [release](https://github.com/bekodesign/Versio-PHP-API/releases "Github releases").
20+
21+
## Usage
22+
23+
**@Todo:** Write documentation
24+
25+
## Testing
26+
27+
This library is using [PHP dotenv](https://github.com/vlucas/phpdotenv) for enviroment variables.
28+
Since Versio is using Basic Auth and does not provide a demo account the tests need access to your full username and password.
29+
30+
In order to run the provided tests:
31+
1. Clone this repository
32+
2. Create a new ``.env`` file in the root of the repository with the following contents:
33+
34+
````
35+
VERSIO_HOST=versio.nl
36+
VERSIO_USERNAME={YOUR VERSIO USERNAME}
37+
VERSIO_PASSWORD={YOUR VERSIO PASSWORD}
38+
````
39+
Replace **{YOUR VERSIO USERNAME}** and **{YOUR VERSIO PASSWORD}** with the credentials you use to sign in at https://www.versio.nl/login?uri=/customer/
40+
41+
You can also change the host to versio.uk, versio.nl, versio.be, versio.eu. But the default fallback is versio.nl.
42+
43+
## License
44+
45+
This project is released under the [MIT][link-license] License.
46+
47+
## Issues
48+
49+
Please report any problems via: [GitHub issues](https://github.com/BekoDesign/Versio-PHP-API/issues)
50+
51+
## Contributors
52+
Feel free to create Pull Request.
53+
54+
**Contributors:**
55+
- [Beko1997](https://github.com/beko1997)

composer.json

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"name": "BekoDesign/versio-php-api",
3+
"description": "PHP implementation of the new Restfull Versio API",
4+
"type": "library",
5+
"license": "MIT",
6+
"version": "1.0.0-dev",
7+
"support": {
8+
"email": "support@bekodesign.com",
9+
"issues": "https://github.com/BekoDesign/Versio-PHP-API/issues"
10+
},
11+
"authors": [
12+
{
13+
"name": "Bert Kooij",
14+
"email": "bertkooij@bekodesign.com"
15+
}
16+
],
17+
"autoload-dev": {
18+
"psr-4": {
19+
"Tests\\": "tests/"
20+
}
21+
},
22+
"require": {
23+
"php": ">=7.0.0",
24+
"php-http/httplug": "^1.1",
25+
"php-http/message": "^1.6",
26+
"php-http/guzzle6-adapter": "^1.1",
27+
"php-http/discovery": "^1.3"
28+
},
29+
"require-dev": {
30+
"phpunit/phpunit": "^5.0",
31+
"vlucas/phpdotenv": "^2.4"
32+
},
33+
"autoload": {
34+
"psr-0": { "BekoDesign\\versioAPI": "lib/" }
35+
}
36+
}

0 commit comments

Comments
 (0)