{"id":18948413,"url":"https://github.com/oxid-esales/graphql-storefront-module","last_synced_at":"2025-08-24T11:12:13.364Z","repository":{"id":38821833,"uuid":"319658020","full_name":"OXID-eSales/graphql-storefront-module","owner":"OXID-eSales","description":"This module provides GraphQL queries and mutations for the OXID eShop store front","archived":false,"fork":false,"pushed_at":"2024-05-22T10:36:48.000Z","size":1995,"stargazers_count":20,"open_issues_count":0,"forks_count":8,"subscribers_count":10,"default_branch":"b-7.1.x","last_synced_at":"2024-05-22T10:55:40.401Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OXID-eSales.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-08T14:08:54.000Z","updated_at":"2024-05-27T12:22:07.087Z","dependencies_parsed_at":"2024-02-05T09:28:57.685Z","dependency_job_id":"f787232a-f272-4d4c-ad26-c2a8b242b867","html_url":"https://github.com/OXID-eSales/graphql-storefront-module","commit_stats":{"total_commits":298,"total_committers":16,"mean_commits":18.625,"dds":0.697986577181208,"last_synced_commit":"2bcae78ebf2ceab0865f87dd7a4eed85b0b6e5c1"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fgraphql-storefront-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fgraphql-storefront-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fgraphql-storefront-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fgraphql-storefront-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OXID-eSales","download_url":"https://codeload.github.com/OXID-eSales/graphql-storefront-module/tar.gz/refs/heads/b-7.1.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248381791,"owners_count":21094528,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T13:13:29.410Z","updated_at":"2025-04-11T11:11:05.638Z","avatar_url":"https://github.com/OXID-eSales.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GraphQL Storefront\n\n[![Build Status](https://img.shields.io/github/workflow/status/OXID-eSales/graphql-storefront-module/CI?logo=github-actions\u0026style=for-the-badge)](https://github.com/OXID-eSales/graphql-storefront-module/actions)\n\n[![Latest Version](https://img.shields.io/packagist/v/OXID-eSales/graphql-storefront?logo=composer\u0026label=latest\u0026include_prereleases\u0026color=orange)](https://packagist.org/packages/oxid-esales/graphql-storefront)\n[![PHP Version](https://img.shields.io/packagist/php-v/oxid-esales/graphql-storefront)](https://github.com/oxid-esales/graphql-storefront-module)\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_graphql-storefront-module\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=OXID-eSales_graphql-storefront-module)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_graphql-storefront-module\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=OXID-eSales_graphql-storefront-module)\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_graphql-storefront-module\u0026metric=sqale_index)](https://sonarcloud.io/dashboard?id=OXID-eSales_graphql-storefront-module)\n\nThis module provides [GraphQL](https://www.graphql.org) queries and mutations for the [OXID eShop](https://www.oxid-esales.com/) storefront.\n\n## Usage\n\nThis 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.\n\n## Branch compatibility\n\n* 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)\n* 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)\n* ^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)\n* 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)\n* 1.x versions (b-6.3.x branch) are compatible with OXID eShop compilation 6.3.x (no PHP8 support)\n\n### Install\n\nSwitch to the shop root directory (the file `composer.json` and the directories `source/` and `vendor/` are located there).\n\n```bash\n# Install desired version of oxid-esales/graphql-storefront module, in this case - latest released 3.x version\n$ composer require oxid-esales/graphql-storefront ^3.0.0\n```\n\nIf you didn't have the `oxid-esales/graphql-base` module installed, composer will do that for you.\n\nYou should run migrations both after installing the module and after each module update:\n\n```bash\n$ vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_graphql_base\n$ vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_graphql_storefront\n```\n\nAfter installing the module, you need to activate it, either via OXID eShop admin or CLI.\n\n```bash\n$ vendor/bin/oe-console oe:module:activate oe_graphql_base\n$ vendor/bin/oe-console oe:module:activate oe_graphql_storefront\n```\n\n### How to use\n\nA good starting point is to check the [How to use section in the GraphQL Base Module](https://github.com/OXID-eSales/graphql-base-module/#how-to-use)\n\n## Testing\n\n### Linting, syntax check, static analysis\n\n```bash\n$ composer update\n$ composer static\n```\n\n### Unit/Integration/Acceptance tests\n\n- install this module into a running OXID eShop\n- reset shop's database\n```bash\n$ 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\n```\n\n- run Unit tests\n```bash\n$ ./vendor/bin/phpunit -c vendor/oxid-esales/graphql-storefront/tests/phpunit.xml\n```\n\n- run Integration tests\n```bash\n$ ./vendor/bin/phpunit --bootstrap=./source/bootstrap.php -c vendor/oxid-esales/graphql-storefront/tests/phpintegration.xml\n```\n- run Acceptance tests\n```bash\n$ SELENIUM_SERVER_HOST=selenium MODULE_IDS=oe_graphql_storefront vendor/bin/codecept run acceptance -c vendor/oxid-esales/graphql-storefront/tests/codeception.yml\n```\n\n## Contributing\n\nYou like to contribute? 🙌 AWESOME 🙌\\\nGo and check the [contribution guidelines](CONTRIBUTING.md)\n\n## Build with\n\n- [GraphQLite](https://graphqlite.thecodingmachine.io/)\n\n## License\n\nOXID Module and Component License, see [LICENSE file](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxid-esales%2Fgraphql-storefront-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxid-esales%2Fgraphql-storefront-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxid-esales%2Fgraphql-storefront-module/lists"}