You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guide/README.md
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Vue Storefront is a rather complex solution with a lot of possibilities. Learnin
9
9
10
10
Vue Storefront is a headless and backend-agnostic eCommerce [Progressive Web App (PWA)](https://developers.google.com/web/progressive-web-apps/) written in Vue.js. The fact that it's using headless architecture allows Vue Storefront to connect with any eCommerce platform so it can be a frontend PWA for Magento, Shopify, BigCommerce, WooCommerce and etc.
11
11
12
-
It's a very popular [Open Source project](https://github.com/DivanteLtd/vue-storefront) with a strong and growing community.
12
+
It's a very popular [Open Source project](https://github.com/vuestorefront/vue-storefront) with a strong and growing community.
13
13
14
14
**Key features of Vue Storefront:**
15
15
- Platform-agnostic
@@ -24,21 +24,21 @@ Vue Storefront is a headless and backend-agnostic eCommerce [Progressive Web App
24
24
25
25
26
26
## How does it connect with backend platforms?
27
-
Vue Storefront manages to be platform-agnostic thanks to the [vue-storefront-api](https://github.com/DivanteLtd/vue-storefront-api) and [dedicated API connectors](https://github.com/DivanteLtd/vue-storefront#integrations) for eCommerce backend platforms. The data format in vue-storefront-api is always the same for any platform, which means no matter what eCommerce backend you use, your frontend remains the same without any change.
27
+
Vue Storefront manages to be platform-agnostic thanks to the [vue-storefront-api](https://github.com/vuestorefront/vue-storefront-api) and [dedicated API connectors](https://github.com/vuestorefront/vue-storefront#integrations) for eCommerce backend platforms. The data format in vue-storefront-api is always the same for any platform, which means no matter what eCommerce backend you use, your frontend remains the same without any change.
28
28
29
29
It's a great strategy for migrations since you can easily migrate from one platform to another (or one version to another, e.g. Magento 1 to 2) without touching your frontend.
-**data pump** ([mage2nosql](https://github.com/DivanteLtd/mage2vuestorefront) in the image) is pulling static data (catalog, orders, etc.) from your eCommerce platform to Vue Storefront Elasticsearch and changes its format to the one consumed by vue-storefront-api. Once finished pulling the data, you can display the product catalog in Vue Storefront. After pumping the data into Elasticsearch is done, it will stay in sync with changes made on the backend platform and update its content accordingly.
35
+
-**data pump** ([mage2nosql](https://github.com/vuestorefront/mage2vuestorefront) in the image) is pulling static data (catalog, orders, etc.) from your eCommerce platform to Vue Storefront Elasticsearch and changes its format to the one consumed by vue-storefront-api. Once finished pulling the data, you can display the product catalog in Vue Storefront. After pumping the data into Elasticsearch is done, it will stay in sync with changes made on the backend platform and update its content accordingly.
36
36
37
37
-**worker pool** is a synchronization process of so-called dynamic calls (user sessions, cart rules, etc.) that couldn't be stored in the database and need to be called by vue-storefront-api directly from the backend platform.
38
38
39
39
VueStorefront works seamlessly with your backend platform while two integration phases are managed as above.
40
40
41
-
Some of the most popular backend platforms already have their integrations ([Magento 2](https://github.com/DivanteLtd/mage2vuestorefront), [Magento 1](https://github.com/DivanteLtd/magento1-vsbridge), [CoreShop](https://github.com/DivanteLtd/coreshop-vsbridge), [BigCommerce](https://github.com/DivanteLtd/bigcommerce2vuestorefront), [WooCommerce](https://github.com/DivanteLtd/woocommerce2vuestorefront)), but you can easily make your own with the [integration boilerplate](https://github.com/DivanteLtd/vue-storefront-integration-boilerplate).
41
+
Some of the most popular backend platforms already have their integrations ([Magento 2](https://github.com/vuestorefront/mage2vuestorefront), [Magento 1](https://github.com/divanteLtd/magento1-vsbridge), [CoreShop](https://github.com/divanteLtd/coreshop-vsbridge), [BigCommerce](https://github.com/divanteLtd/bigcommerce2vuestorefront), [WooCommerce](https://github.com/divanteLtd/woocommerce2vuestorefront)), but you can easily make your own with the [integration boilerplate](https://github.com/divanteLtd/vue-storefront-integration-boilerplate).
42
42
43
43
The blue parts on the diagram are responsible for offline cache and will be explained later in the article.
44
44
@@ -56,7 +56,7 @@ To summarize: Your shop is basically a Vue Storefront theme that uses features p
56
56
57
57
Knowing these 3 concepts allows you to confidently work with Vue Storefront and make your own shops.
When you want to play with Vue Storefront, there are three options:
@@ -72,7 +72,7 @@ To do any of this, simply type `yarn installer` in the root of the project and a
72
72
73
73
## Vue Storefront config file
74
74
75
-
Most of the Vue Storefront configuration (like the active theme, backend API addresses, multistore setup, etc.) is done through its [config](https://docs.vuestorefront.io/guide/basics/configuration.html) file that can be found under the `config` folder. The `default.json` file contains all the default setup.
75
+
Most of the Vue Storefront configuration (like the active theme, backend API addresses, multistore setup, etc.) is done through its [config](/guide/basics/configuration.html) file that can be found under the `config` folder. The `default.json` file contains all the default setup.
76
76
77
77
For your own implementation you should create a `local.json` file in the same directory and include fields from `default.json` that you want to override. These two files will be merged in favor of `local.json` during the build process. If you use the installer to set up your Vue Storefront instance, it'll generate proper config files.
78
78
@@ -87,7 +87,7 @@ The mechanism of injecting core business logic into themes is ridiculously simpl
87
87
88
88
So assume we have a core Microcart component with business logic as above (left side), we can easily inject it into any of our theme components (right side) just by importing it and adding as a mixin `mixins: [Microcart]`. This is all you need to make use of core business logic inside your theme. With this approach, we can easily ship updates to all core components without breaking your shop.
89
89
90
-
[Check how to create theme based on our official themes](https://docs.vuestorefront.io/guide/installation/theme.html).
90
+
[Check how to create theme based on our official themes](/guide/installation/theme.html).
91
91
92
92
## Offline mode and cache
93
93
Vue Storefront still works even while the user is offline.
@@ -112,12 +112,12 @@ You may not believe me but this is all you need to know to start working with Vu
Copy file name to clipboardExpand all lines: docs/guide/archives/components.md
+22-22Lines changed: 22 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -224,7 +224,7 @@ Simple modal component. Visibility of modal container is based on internal state
224
224
225
225
#### Styles
226
226
227
-
Core component doesn't have CSS styles. If you want to see an example of our implementation please look [here](https://github.com/DivanteLtd/vue-storefront/blob/master/src/themes/default/components/core/Modal.vue)
227
+
Core component doesn't have CSS styles. If you want to see an example of our implementation please look [here](https://github.com/vuestorefront/vue-storefront/blob/master/src/themes/default/components/core/Modal.vue)
228
228
229
229
230
230
@@ -235,88 +235,88 @@ To keep track and make debugging of `$bus.$emit` events across components easier
0 commit comments