nodeless-io/nodeless-php

Nodeless.io PHP client library.

0.0.1 2023-05-03 22:13 UTC

Requires

• php: >=8.0
• ext-bcmath: *
• ext-curl: *
• ext-json: *
• ext-mbstring: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpunit/phpunit: ^9.5
• vimeo/psalm: ^4.8
• vlucas/phpdotenv: ^5.5

MIT

• nodless.io development team

README

How to use with composer

composer require nodeless-io/nodeless-php

If you use some framework or other project you likely are ready to go. If you start from scratch make sure to include Composer autoloader.

require __DIR__ . '/../vendor/autoload.php';

How to use without composer (not recommended)

In the src directory we have a custom autoload.php which you can require and avoid using composer if needed.

// Require the autoload file.
require __DIR__ . '/../src/autoload.php';

// Example to get all stores.
$apiKey = '';
$host = ''; // e.g. https://nodeless.io

try {
    $client = new \NodelessIO\Client\Store($host, $apiKey);
    var_dump($client->getStores());
} catch (\Throwable $e) {
    echo "Error: " . $e->getMessage();
}

FAQ

Where to get the API key from?

Contribute

We run static analyzer Psalm and PHP-CS-fixer for codestyle when you open a pull-request. Please check if there are any errors and fix them accordingly.

Codestyle

We use PSR-12 code style to ensure proper formatting and spacing. You can test and format your code using composer commands. Before doing a PR you can run composer cs-check and composer cs-fix which will run php-cs-fixer.