magento2-1: A TypeScript repository from hiepnt93

Vue Storefront 2 integration with Magento (WIP)

This project is a Magento 2 integration for Vue Storefront 2. This integration is being developed by superheroes from Cyberfuze, Ecritel 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.2 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
Define a store running environment by adding a STORE_ENV to your running project or execute the code
```
$ echo "STORE_ENV=dev" >> .env
```
Copy config/example.json to an environment named config and update GraphQL Endpoint
```
$ cp packages/theme/config/example.json packages/theme/config/dev.json
```
Update magentoGraphQl with url to Magento >=2.4.2 GraphQL endpoint, and the other variable accordingly to your store configurations.
```
"magentoGraphQl": "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

If you need HMR on Api Client/Composables run yarn dev:api-client or yarn 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 ✨

Thanks goes to these wonderful people (emoji key):

_{Heitor Ramon Ribeiro} 💻 🚧 📆	_{Dominik Deimel} 💻 📖	_{Lior Lindvor} 💻	_{Alef Barbeli} 📖	_{Henrique Lopes} 📖	_{Filip Rakowski} 💬 🧑‍🏫 👀	_{Filip Sobol} 💬 🧑‍🏫 👀
_{Patryk Andrzejewski} 💬 🧑‍🏫 👀	_{Renan Oliveira} 🔧 🔌

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

hiepnt93/magento2-1