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

Branch compatibility

• b-7.6.x branch is compatible with OXID eShop compilation b-7.6.x (which uses graphql-base 14.x version resp. b-7.6.x branch)
• 5.x versions (or b-7.5.x branch) are compatible with OXID eShop compilation b-7.5.x (which uses graphql-base 13.x version resp. b-7.5.x branch)
• 4.2.x versions (or b-7.4.x branch) are compatible with OXID eShop compilation b-7.4.x (which uses graphql-base 12.x version resp.b-7.4.x branch)
• 4.1.x version (or b-7.3.x branch) are compatible with OXID eShop compilation b-7.3.x (which uses graphql-base 11.x version resp.b-7.3.x branch)
• 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 5.x version
$ composer require oxid-esales/graphql-storefront ^5.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

Development installation on OXID eShop SDK

The installation instructions below are shown for the current SDK for shop 7.6. Make sure your system meets the requirements of the SDK.

1. Ensure all docker containers are down to avoid port conflicts

2. Clone the SDK for the new project

echo MyProject && git clone https://github.com/OXID-eSales/docker-eshop-sdk.git $_ && cd $_

1. Clone the repository to the source directory

git clone --recurse-submodules https://github.com/OXID-eSales/graphql-storefront-module.git --branch=b-7.6.x ./source

1. Run the recipe to setup the development environment

./source/recipes/setup-development.sh

You should be able to access the shop with http://localhost.local and the admin panel with http://localhost.local/admin (credentials: noreply@oxid-esales.com / admin)

Running tests locally

Check the "scripts" section in the composer.json file for the available commands. Those commands can be executed by connecting to the php container and running the command from there, example:

make php
composer tests-coverage

Commands can be also triggered directly on the container with docker compose, example:

docker compose exec -T php composer tests-coverage

Contributing

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

Build with

• GraphQLite

License

OXID Module and Component License, see LICENSE file.