Vue Storefront 2 integration with Magento

@vue-storefront/magento-api

This is only the api-client package, you need to install the other dependencies also.

This project is a Magento 2 integration for Vue Storefront 2. This integration developed by superheroes from Caravel ❤️

How to start if you want to try out the integration

Please follow the installation guide

How to start if you want to contribute?

Want to contribute? Ping us on magento2 channel on our Discord!

Requirements:

• NodeJS v16 or later
• Yarn
• Magento >= v2.4.3 instance for GraphQL endpoint
• Change Magento GraphQL Query Complexity and Depth values

Don't forget to change the Magento GraphQL Query Complexity and Depth values Magento 2 by default has a lower value for the complexity of 300, and a higher value for the depth of 20. Magento 2 - Issue #32427

The changes are required, due to the size of the queries and mutations in the api-client implementation.

To do this changes, you can use the Magento 2 module, which adds a configuration panel to your admin, or do this changes manually.

To install the Magento 2 GraphQL Config module, on your Magento installation execute:

composer require caravelx/module-graphql-config

php bin/magento module:enable Caravel_GraphQlConfig

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

Find more information about the module GraphQl Custom Config

Steps

1. Fork the repo
2. Clone your fork of the repo

   example:
   git clone https://github.com/vuestorefront/magento2.git
   cd magento2

3. Checkout develop branch git checkout develop
4. Run yarn to install dependencies
5. Copy .env.example to .env

   $ cp packages/theme/.env.example packages/theme/config/.env

6. Update VSF_MAGENTO_GRAPHQL_URL with url to Magento >=2.4.2 GraphQL endpoint, and the other variable accordingly to your store configurations.

   VSF_MAGENTO_GRAPHQL_URL=https://{YOUR_SITE_FRONT_URL}/graphql

7. Build dependencies yarn build:api-client && yarn build:composables
8. Run yarn dev:theme to run theme. You can find other commands in package.json

• If you need HMR on Api Client/Composables run yarn dev:api-client or yarn dev:composables on a separate terminal window.

Resources

• Vue Storefront Documentation
• Magento 2 integration Documentation (WIP)
• Community Chat

Support

If you have any questions about this integration we will be happy to answer them on magento2 channel on our Discord.

Contributors ✨

Honorable Mentions

• Caravel x
• Cyberfuze
• Leonex

Thanks go to these wonderful people 🙌:

This project follows the all-contributors specification. Contributions of any kind welcome!