myparcelnl/pdk

MyParcel Plugin Development Kit

2.40.0 2024-07-17 16:04 UTC

Requires

• php: >=7.1.0
• justinrainbow/json-schema: ^5.2
• myparcelnl/sdk: >= 7
• php-di/php-di: >= 6
• psr/log: ^1 || ^2 || ^3
• symfony/http-foundation: >= 2 || >= 3 || >= 4 || >= 5

Requires (Dev)

• behat/behat: ^3.13
• brick/varexporter: ^0.4
• guzzlehttp/guzzle: ^7.5
• myparcelnl/devtools: >= 1
• nette/robot-loader: >= 3
• pestphp/pest: >= 1
• phpdocumentor/reflection-docblock: ^5
• phpstan/phpstan: >= 1
• rector/rector: >= 1
• spatie/pest-plugin-snapshots: >= 1
• symfony/console: *

MIT

• Edie Lemoine

README

The MyParcel PDK (Plugin Development Kit) is meant for developing entire plugins on PHP E-Commerce platforms. If you're just looking to connect to our API without creating an entire plugin, you should check out our php SDK.

Requirements

• PHP >=7.1
• Composer

Documentation

For examples, guides and in-depth information, visit our Plugin Development Kit (PDK) documentation.

Support

Create an issue or contact us via our Developer Portal contact page.

Contributing

View our contribution guidelines for information on how to contribute to the PDK.

Prerequisites

• Node 18
• Yarn
• Docker

Installation

Create .env.local:

cp .env.local.template .env.local

Install Yarn dependencies:

yarn

Install Composer dependencies:

docker compose up php

Running tests

Run all tests:

docker compose run php composer test

Linting

We use Prettier to format .json, .yml, .md and .html files.

Make sure Prettier is enabled in your IDE and runs on the following files:

{**/*,*}.{md,html,yml,json}

Set up Git hooks to run Prettier on each commit, correcting any formatting issues.

yarn prepare

You can also run Prettier manually:

# Check formatting issues
yarn lint

# Fix formatting issues
yarn lint:fix