/bold-shopify-toolkit

A Symfony Based Shopify api wrapper

Primary LanguagePHPApache License 2.0Apache-2.0

Bold Shopify Toolkit

CircleCI

Bold Shopify Toolkit is a Symfony-based Shopify wrapper that makes it easy to interact with Shopify.

Getting Started

This package works best with a Dependency Injection Container since there are many dependencies that need to be resolved.

Prerequisites

To use this package, you will need to bind Models to the following interfaces.

An example API Sleeper has been included in this package.

Laravel: (see AppServiceProvider.php)

    $this->app->bind(\BoldApps\ShopifyToolkit\Contracts\ApiSleeper::class,
            \BoldApps\ShopifyToolkit\Support\ShopifyApiHandler::class);

Installing

Add to composer.json

$ composer require bold-commerce/bold-shopify-toolkit

Bind the appropriate models during your request lifecycle.

    $this->app->bind(\BoldApps\ShopifyToolkit\Contracts\ApiSleeper::class,
            \BoldApps\ShopifyToolkit\Support\ShopifyApiHandler::class);

    ...

Running the tests

$ vendor/bin/phpunit tests

TODO

  • Add more tests
  • Examples

Contributing

Pull requests and ideas are welcome! Open an issue and lets talk.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache 2 License - see the LICENSE.md file for details

Acknowledgments

  • Thanks to Shopify for making the best Developer Network!
  • Thanks to Bold Commerce Developers for making this amazing package