Skip to content

Latest commit

 

History

History
126 lines (98 loc) · 4.07 KB

installation.md

File metadata and controls

126 lines (98 loc) · 4.07 KB
Raw

Installation

  1. Require plugin with composer:

    composer require bitbag/vue-storefront2-plugin

  2. Add plugin dependencies to your config/bundles.php file:

        return [
     ...
    
        BitBag\SyliusVueStorefront2Plugin\BitBagSyliusVueStorefront2Plugin::class => ['all' => true],
    ];

  3. Enable API In config/services.yaml

        sylius_api:
        enabled: true

  4. Add plugin mapping path to your config/packages/api_platform.yaml file as a last element:

        api_platform:
        mapping:
            paths:
                - '%kernel.project_dir%/vendor/bitbag/vue-storefront2-plugin/src/Resources/api_resources'

  5. Add plugin serialization files path to your config/packages/framework.yaml file (Remeber to include here Your own serialization files path, without it - fields using serialization groups wont be visible in GraphQL Schema):

        framework:    
        serializer:
            mapping:
                paths:
                    - '%kernel.project_dir%/vendor/bitbag/vue-storefront2-plugin/src/Resources/serialization'

  6. Import required config by adding config/packages/bitbag_sylius_vue_storefront2_plugin.yaml file:

    # config/packages/bitbag_sylius_vue_storefront2_plugin.yaml

imports:
    - { resource: "@BitBagSyliusVueStorefront2Plugin/Resources/config/services.xml" }

    There are 2 plugin parameters that You can adjust:

    bitbag_sylius_vue_storefront2:
    refresh_token_lifespan: 2592000 #that its default value
    test_endpoint: 'http://127.0.0.1:8080/api/v2/graphql' #that its default value

  7. Add doctrine mapping:

    doctrine:
    orm:
        mappings:
            VueStorefront2:
                is_bundle: false
                type: xml
                dir: '%kernel.project_dir%/vendor/bitbag/vue-storefront2-plugin/src/Resources/doctrine/model'
                prefix: 'BitBag\SyliusVueStorefront2Plugin\Model'
                alias: BitBag\SyliusVueStorefront2Plugin

  8. In _sylius.yaml add mappings for product attribute and taxonomy repository so graphql can see them properly

    sylius_taxonomy:
   resources:
      taxon:
         classes:
            repository: BitBag\SyliusVueStorefront2Plugin\Doctrine\Repository\TaxonRepository

  9. If you're extending Sylius' ProductAttributeValue entity, please use our trait inside: BitBag\SyliusVueStorefront2Plugin\Model\ProductAttributeValueTrait. Otherwise, please create an entity, which uses the trait and setup the Sylius resource in _sylius.yaml:

    sylius_attribute:
        driver: doctrine/orm
        resources:
            product:
                subject: Sylius\Component\Core\Model\Product
                attribute_value:
                    classes:
                        model: App\Entity\ProductAttributeValue
  1. Please add the Doctrine mapping configuration into your project:
<?xml version="1.0" encoding="UTF-8"?>

<doctrine-mapping
    xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
                            http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd"
>
    <entity name="Tests\BitBag\SyliusVueStorefront2Plugin\Entity\ProductAttributeValue" table="sylius_product_attribute_value">
        <indexes>
            <index name="locale_code" columns="locale_code" />
        </indexes>
    </entity>
</doctrine-mapping>

Please change the name attribute to fit your entity name. If you've already the ProductAttributeValue mapping in your project, just add there the <index> part of mapping above.

  1. Import routing in routes.yaml
bitbag_sylius_vue_storefront2_plugin:
    resource: "@BitBagSyliusVueStorefront2Plugin/Resources/config/routing.yml"