oxid-esales / graphql-storefront
OXID eSales GraphQL storefront module
Installs: 11 515
Dependents: 3
Suggesters: 0
Security: 0
Stars: 13
Watchers: 8
Forks: 9
Type:oxideshop-module
Requires
- php: ^7.4 | ^8.0
- doctrine/dbal: ^v2.7
- oxid-esales/graphql-base: ^7.0.1
Requires (Dev)
- codeception/module-db: *
- codeception/module-phpbrowser: ^1.0.2
- codeception/module-rest: ^1.4.2
- oxid-esales/oxideshop-ce: ^v6.10.0
- phpmd/phpmd: ^2.11
- phpstan/phpstan: ^0.12.26
- phpunit/phpunit: ^7.5.20|^8.5|^9
- qossmic/deptrac-shim: ^0.9.0|^0.10.0
- squizlabs/php_codesniffer: 3.*
- dev-b-6.5.x
- v2.1.0
- v2.0.1
- v2.0.0
- v1.0.0
- v1.0.0-rc1
- v0.1.0
- dev-b-7.0.x
- dev-b-7.0.x-new_license-OXDEV-6849
- dev-b-7.0.x-fix_all_tests-OXDEV-6255
- dev-master-installable-OXDEV-6054
- dev-master
- dev-b-6.5.x_OAI_Spike-OXDEV-6060
- dev-b-6.5.x-refactor_tests
- dev-b-6.5.x-sonarcloud_fixes-OXDEV-5421
- dev-pr11
- dev-pr10
- dev-b-6.5.x_improve_styles_run
- dev-master-restore-productId-in-AddItem-events
- dev-b-6.5.x-improvements-OXDEV-4888
- dev-b-6.5.x_backport_from_master-OXDEV-5214
- dev-master-b-6.5.x-merge
- dev-b-6.5.x-adjust_github_actions-OXDEV-5160
- dev-b-6.4.x
- dev-b-6.4.x-fix_user_switch-OXDEV-5002
- dev-master-fix_user_switch-OXDEV-5002
- dev-b-6.3.x
- dev-b-6.4.x-remove_shared_bakset_infrastructure_call
- dev-b-6.2.x
- dev-b-6.2.x-set_empty_session_basket
- dev-b-6.4.x-services-OXDEV-4968
- dev-b-6.3.x-improvements-OXDEV-4888
- dev-master-merge_b-6.4.x-OXDEV-4946
- dev-basket_action_events-OXDEV-4424
- dev-master-spike_custom_prices-OXDEV-4503
- dev-master_extend_test-OXDEV-4790
- dev-master-anonymous_basket-OXDEV-4354-event
This package is auto-updated.
Last update: 2023-03-28 13:48:49 UTC
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: v6.8.0
component, which is part of the v6.3.0
compilation) up and running.
Branch compatibility
- master branch is compatible with OXID eShop b-7.0 (which uses
graphql-base
master 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 2.x version
$ composer require oxid-esales/graphql-storefront ^2.0.0
$ 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 update
$ 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 thepartial_module_paths
- set
activate_all_modules
totrue
- add
-
$ 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.