Skip to content

Commit 2b35890

Browse files
chore: introduction update
1 parent 0a72c35 commit 2b35890

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

docs/guide/general/introduction.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,15 @@ It's a great strategy for migrations since you can easily migrate from one platf
3030

3131
![Architecture diagram](https://raw.githubusercontent.com/vuestorefront/vue-storefront/master/docs/.vuepress/public/GitHub-Architecture-VS.png)
3232

33-
The API connector works in two phases:
34-
- **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.
33+
- **VSBridge Indexer** ([magento2-vsbridge-indexer](https://github.com/vuestorefront/magento2-vsbridge-indexer) in the image) is multi-process data synchronizer between Magento to Vue Storefront ElasticSearch database which is sending data about products, categories, taxrules, attributes, reviews, cms blocks and pages.
3534

36-
- **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.
35+
- **VSF-API (or SF-API)** is just a proxy to the eCommerce backend which gives us variety of benefits like caching layer, mapping to agnostic types, possibility to create own "processors" (mapping functions for certain entities).
3736

3837
VueStorefront works seamlessly with your backend platform while two integration phases are managed as above.
3938

40-
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).
39+
Some of the most popular backend platforms already have their integrations ([Magento 2](https://github.com/vuestorefront/magento2-vsbridge-indexer), [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).
40+
41+
At the moment we are only maintaining `magento2-vsbridge-indexer`.
4142

4243
The blue parts on the diagram are responsible for offline cache and will be explained later in the article.
4344

@@ -47,16 +48,14 @@ There are 3 concepts you need to be familiar with while working with Vue Storefr
4748

4849
- **Vue Storefront Core** ( `core` folder) is the glue for all the features that allow Vue Storefront to work. It contains all the entry points, SSR behavior, build process, in-app libs and helpers. You shouldn't touch this folder directly when building your own implementations in order to stay up-to-date with its features and security.
4950

50-
- **Vue Storefront Modules** ( `core/modules` and `src/modules` ) are the eCommerce features. Each module is one encapsulated feature (like cart, wishlist, catalog, and some third-party integrations). You can add/remove/edit these modules as you wish and compose your Vue Storefront shop with only the features that you need. They are also used for 3rd-party extensions.
51+
- **Vue Storefront Modules** ( `core/modules` and `src/modules` ) are the eCommerce features. Each module is one encapsulated feature (like cart, wishlist, catalog, and some third-party integrations). You can add/remove/edit these modules as you wish and compose your Vue Storefront shop with only the features that you need. There are also used for 3rd-party extensions.
5152

52-
- **Vue Storefront Themes** ( `src/themes` ) are the actual shop implementation. In themes, you can use and extend all the logic from registered modules / core and add your HTML markup and styles. Vue Storefront provides a fully customizable default theme.
53+
- **Vue Storefront Themes** ( `src/themes` ) are the actual shop implementation. In themes, you can use and extend all the logic from registered modules / core and add your HTML markup and styles. Vue Storefront provides a fully customizable [default theme](https://github.com/vuestorefront/vsf-default) and [capybara theme](https://github.com/vuestorefront/vsf-capybara). We recommend using default theme because is more stable than capybara theme.
5354

5455
To summarize: Your shop is basically a Vue Storefront theme that uses features provided by modules. Vue Storefront Core glues it all together.
5556

5657
Knowing these 3 concepts allows you to confidently work with Vue Storefront and make your own shops.
5758

58-
Useful materials: [Vue Storefront project structure](/guide/basics/project-structure.html)
59-
6059
## Installing Vue Storefront
6160
When you want to play with Vue Storefront, there are three options:
6261

@@ -101,7 +100,7 @@ We managed to do this by making extensive use of the browser cache. 
101100
Please note that Service Worker works only in production mode.
102101
:::
103102

104-
- **For the catalog and store-data cache** we use IndexedDB and Local Storage. We also prefetch products from visited categories so once you enter one, all of its products are available offline. The mechanism of offline storage is located under `core/lib/store/`.
103+
- **For the catalog and store-data cache** we use LocalForage. We also prefetch products from visited categories so once you enter one, all of its products are available offline. The mechanism of offline storage is located under `core/lib/store/`.
105104

106105
We use some of the cached data even while the user is online to display the content instantly. This explains why Vue Storefront is lightning fast.
107106

0 commit comments

Comments
 (0)