## Vue Storefront 2 integration with Magento
Contributors
This project is a Magento 2 integration for Vue Storefront 2.
This integration developed by superheroes from Caravel and Leonex
How to start if you want to try out the integration
yarn global add @vue-storefront/cli
vsf init <project_name> && cd <project_name> && yarn && yarn dev
How to start if you want to contribute?
Want to contribute? Ping us on magento2-vsf2
channel on our Discord!
Requirements:
- NodeJS v14 or later
- Magento >= v2.4 instance for GraphQL endpoint
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 and update GraphQL Endpoint
cp packages/theme/.env.example .env
- Update
MAGENTO_GRAPHQL=
with url to Magento 2.4 GrapgQL endpointMAGENTO_GRAPHQL=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 inpackage.json
- If you need HMR on Api Client/Composables run
yarn dev:api-client
oryarn dev:composables
on a separate terminal window.
Resources
Support
If you have any questions about this integration we will be happy to answer them on magento2-vsf2
channel on our Discord.
✨
Contributors Honorable Mentions
Thanks go to these wonderful people (emoji key):
Heitor Ramon Ribeiro |
Alef Barbeli |
Dominik Deimel |
Lior Lindvor |
Henrique Lopes |
Đại Lộc Lê Quang |
Filip Rakowski |
Filip Sobol |
Patryk Andrzejewski |
Renan Oliveira |
This project follows the all-contributors specification. Contributions of any kind welcome!