oxid-esales/graphql-storefront

OXID eSales GraphQL storefront module

v4.0.0-rc.1 2024-11-04 11:18 UTC

Requires

• php: ^8.2
• doctrine/dbal: ^v2.7
• oxid-esales/graphql-base: ^v10.0.0-rc.1

Requires (Dev)

• codeception/c3: ^2.9
• codeception/codeception: ^5.0
• codeception/module-asserts: ^3.0
• codeception/module-db: *
• codeception/module-phpbrowser: ^3.0
• codeception/module-rest: ^3.3
• mikey179/vfsstream: ^1.6
• oxid-esales/codeception-modules: dev-b-7.2.x
• oxid-esales/oxideshop-ce: dev-b-7.2.x
• phpmd/phpmd: ^2.11
• phpstan/phpstan: ^1.10.58
• phpunit/phpunit: ^10.4
• qossmic/deptrac-shim: ^1.0.2
• squizlabs/php_codesniffer: 3.*

Conflicts

• oxid-esales/graphql-account: *
• oxid-esales/graphql-catalogue: *
• oxid-esales/graphql-checkout: *
• oxid-esales/oxideshop-ce: <7.2

proprietary

• modules
• eshop
• OXID
• graphql

README

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: v7.0.0 component, which is part of the v7.0.0 compilation) up and running.

Branch compatibility

• 4.0.x versions (or b-7.2.x branch) are compatible with OXID eShop compilation b-7.2.x (which uses graphql-base 10.x version resp. b-7.2.x branch)
• 3.1.x versions (or b-7.1.x branch) are compatible with OXID eShop compilation b-7.1.x (which uses graphql-base 9.x version resp. b-7.1.x branch)
• 3.x versions (or b-7.0.x branch) are compatible with OXID eShop compilation b-7.0.x (which uses graphql-base 8.x version resp. b-7.0.x branch)
• ^2.1 versions (b-6.5.x branch) are compatible with OXID eShop compilation b-6.5.x (which uses graphql-base 7.x version resp. b-6.5.x branch)
• 2.0.x versions (b-6.4.x branch) are compatible with OXID eShop compilation b-6.4.x (which uses graphql-base 6.x version resp. b-6.4.x branch)
• 1.x versions (b-6.3.x branch) are compatible with OXID eShop compilation 6.3.x (no PHP8 support)

Install

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

# Install desired version of oxid-esales/graphql-storefront module, in this case - latest released 3.x version
$ composer require oxid-esales/graphql-storefront ^3.0.0

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

You should run migrations both after installing the module and after each module update:

$ vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_graphql_base
$ vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_graphql_storefront

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

$ composer update
$ composer static

Unit/Integration/Acceptance tests

• install this module into a running OXID eShop
• reset shop's database

$ bin/oe-console oe:database:reset --db-host=db-host --db-port=db-port --db-name=db-name --db-user=db-user --db-password=db-password --force

• run Unit tests

$ ./vendor/bin/phpunit -c vendor/oxid-esales/graphql-storefront/tests/phpunit.xml

• run Integration tests

$ ./vendor/bin/phpunit --bootstrap=./source/bootstrap.php -c vendor/oxid-esales/graphql-storefront/tests/phpintegration.xml

• run Acceptance tests

$ SELENIUM_SERVER_HOST=selenium MODULE_IDS=oe_graphql_storefront vendor/bin/codecept run acceptance -c vendor/oxid-esales/graphql-storefront/tests/codeception.yml

Contributing

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

Build with

• GraphQLite

License

OXID Module and Component License, see LICENSE file.