Giter Club home page Giter Club logo

graphql-storefront-module's Introduction

oxid-esales/graphql-storefront

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.

Install

$ composer require oxid-esales/graphql-storefront

$ ./bin/oe-console oe:module:install-configuration ./vendor/oxid-esales/graphql-base
$ ./bin/oe-console oe:module:install-configuration ./vendor/oxid-esales/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.

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

Branch Compatibility

  • master branch is compatible with OXID eShop compilation master (which uses graphql-base master branch)
  • b-6.x branch is compatible with OXID eShop compilation b-6.x (which uses graphql-base b-6.x branch)

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.