Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vuestorefront-community/kibocommerce

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/vuestorefront-community/kibocommerce
Owner: vuestorefront-community
License: mit
Created: 2021-09-09T13:25:47.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2022-06-07T14:31:12.000Z (over 2 years ago)
Last Synced: 2024-05-22T16:31:49.805Z (8 months ago)
Language: TypeScript
Size: 3.66 MB
Stars: 1
Watchers: 10
Forks: 12
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-vuestorefront - Repository

README

### Stay connected

[![GitHub Repo stars](https://img.shields.io/github/stars/vuestorefront/vue-storefront?style=social)](https://github.com/vuestorefront/vue-storefront)
[![Twitter Follow](https://img.shields.io/twitter/follow/vuestorefront?style=social)](https://twitter.com/vuestorefront)
[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCkm1F3Cglty3CE1QwKQUhhg?style=social)](https://www.youtube.com/c/VueStorefront)
[![Discord](https://img.shields.io/discord/770285988244750366?label=join%20discord&logo=Discord&logoColor=white)](https://discord.vuestorefront.io)

## Vue Storefront 2 integration with KiboCommerce

## How to start if you want to try out the integration

```
yarn global add @vue-storefront/cli
```
```
vsf init && cd && yarn && yarn dev
```

## How to start if you want to contribute?

Want to contribute? Ping us on `kibocommerce` channel on [our Discord](https://discord.vuestorefront.io)!

### Requirements:
- NodeJS v14 or later
- KiboCommerce Account
### Steps
1. Fork the repo
2. Clone your fork of the repo
```
example:
git clone https://github.com/vuestorefront/kibocommerce.git
cd kibocommerce
```
3. Checkout develop branch `git checkout develop`
4. Run `yarn` to install dependencies
5. Define a store running environment by adding a STORE_ENV to your running project or execute the code
```$ echo "STORE_ENV=dev" >> .env```
6. Copy config/example.json to an environment named config and update GraphQL Endpoint
```
$ cp packages/theme/config/example.json packages/theme/config/dev.json
```
7. Update clientId and sharedSecret with your respective Application Client ID and Shared secret found in your Kibo Commerce Developer Console. Visit [Kibo documentation](https://apidocs.kibong-perf.com/?spec=graphql#auth) for more details on API authentication
8. Update apiHost to point at your Kibo Commerce site.
9. Build dependencies `yarn build:api-client && yarn build:composables`
10. 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

- [Vue Storefront Documentation](https://docs.vuestorefront.io/v2/)
- [kibocommerce integration Documentation](https://docs.vuestorefront.io/kibocommerce)
- [Community Chat](https://discord.vuestorefront.io)

## Support

If you have any questions about this integration we will be happy to answer them on `kibocommerce` channel on [our Discord](discord.vuestorefront.io).

## Contributors ✨

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!