This is a template, to use it you must rename the project changing the {YOUR INTEGRATION NAME}
to the name of the integration you are developing. The name must be in lowercase and without any special characters.
grep -rl '__replace_me__' ./ | xargs sed -i '' 's/__replace_me__/{YOUR INTEGRATION NAME}/g'
To learn how to build your integration, see our Integration guide.
yarn global add @vue-storefront/cli
vsf init <project_name> && cd <project_name> && yarn && yarn dev
Want to contribute? Ping us on __replace_me__
channel on our Discord!
- NodeJS v14 or later
- Fork the repo
- Clone your fork of the repo
example: git clone https://github.com/vuestorefront/__replace_me__.git cd __replace_me__
- Run
yarn
to install dependencies - 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.
If you have any questions about this integration we will be happy to answer them on __replace_me__
channel on our Discord.
This project follows the all-contributors specification. Contributions of any kind welcome!