oxid-esales/graphql-storefront

OXID eSales GraphQL storefront module

Installs: 3 564

Dependents: 3

Suggesters: 0

Security: 0

Stars: 2

Watchers: 9

Forks: 5

Type:oxideshop-module


README

Build Status

Latest Version PHP Version

Quality Gate Status Coverage Technical Debt

This module provides GraphQL queries and mutations for the OXID eShop storefront.

Usage

This assumes you have OXID eShop (at least oxid-esales/oxideshop_ce: v6.5.0 component, which is part of the v6.2.0 compilation) up and running.

Branch compatibility

  • master branch is compatible with OXID eShop b-7.0 (which uses graphql-base master branch)
  • b-6.4.x branch is compatible with OXID eShop compilation b-6.4.x (which uses graphql-base b-6.4.x branch)
  • b-6.3.x branch is compatible with OXID eShop compilation b-6.3.x (which uses graphql-base b-6.3.x branch)
  • b-6.2.x branch is compatible with OXID eShop compilation b-6.2.x (which uses graphql-base b-6.2.x branch)

Install

Switch to the shop root directory (the file composer.json and the directories source/ and vendor/ are located there).

$ composer require oxid-esales/graphql-storefront

$ vendor/bin/oe-console oe:module:install-configuration source/modules/oe/graphql-base
$ vendor/bin/oe-console oe:module:install-configuration source/modules/oe/graphql-storefront

$ ./vendor/bin/oe-eshop-doctrine_migration migration:migrate oe_graphql_storefront

If you didn't have the oxid-esales/graphql-base module installed, composer will do that for you.

After installing the module, you need to activate it, either via OXID eShop admin or CLI.

$ vendor/bin/oe-console oe:module:activate oe_graphql_base
$ vendor/bin/oe-console oe:module:activate oe_graphql_storefront

How to use

A good starting point is to check the How to use section in the GraphQL Base Module

Testing

Linting, syntax check, static analysis and unit tests

$ composer test

Integration/Acceptance tests

  • install this module into a running OXID eShop
  • change the test_config.yml
    • add oe/graphql-base,oe/graphql-storefront to the partial_module_paths
    • set activate_all_modules to true
  • $ composer require codeception/module-rest --dev
    $ composer require codeception/module-phpbrowser --dev
    $ composer require codeception/module-db --dev
$ vendor/bin/runtests
$ vendor/bin/runtests-codeception

Contributing

You like to contribute? 🙌 AWESOME 🙌
Go and check the contribution guidelines

Build with

License

GPLv3, see LICENSE file.