@vue-storefront/magento NPM

deprecated @vue-storefront/magento

If you are looking for Ve Storefront integration for Magento 2, please follow these links:

How to start if you want to try out the integration

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

Fork the repo

Clone your fork of the repo

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

Checkout develop branch git checkout develop
Run yarn to install dependencies

Copy .env.example to .env

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

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
```
Build dependencies yarn build:api-client && yarn build:composables
Run yarn dev:theme to run theme. You can find other commands in package.json