yarn global add @vue-storefront/cli
vsf init <project_name> && cd <project_name> && yarn && yarn dev
Want to contribute? Ping us on kibocommerce
channel on our Discord!
- NodeJS v14 or later
- KiboCommerce Account
- Fork the repo
- Clone your fork of the repo
example: git clone https://github.com/vuestorefront/kibocommerce.git cd kibocommerce
- 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 clientId and sharedSecret with your respective Application Client ID and Shared secret found in your Kibo Commerce Developer Console. Visit Kibo documentation for more details on API authentication
- Update apiHost to point at your Kibo Commerce site.
- 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 kibocommerce
channel on our Discord.
This project follows the all-contributors specification. Contributions of any kind welcome!