|
1 | 1 | # Virto Commerce Storefront Kit |
2 | 2 |
|
3 | | -[](https://www.facebook.com/sharer.php?u=https://virtocommerce.com) [](https://twitter.com/intent/tweet?text=%23VirtoCommerce%20puts%20the%20best%20of%20MS%20Azure%20Cloud%2C%20open%20source%20.Net%20code%20and%20agile%20development%20in%20a%20single%20enterprise%20%23ecommerce%20platform.) [](https://github.com/VirtoCommerce/vc-storefront/releases/latest) [](https://github.com/VirtoCommerce/vc-storefront/releases) [](https://virtocommerce.com/open-source-license) |
4 | | - |
5 | 3 | [](https://github.com/VirtoCommerce/vc-storefront/actions?query=workflow%3A"Storefront+CI") [](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-storefront) [](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-storefront) [](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-storefront) [](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-storefront) [](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-storefront&branch=dev&metric=ncloc)  |
6 | 4 |
|
7 | | -[](https://virtocommerce.com/docs/latest/) [](https://www.virtocommerce.org) [](https://github.com/VirtoCommerce/vc-storefront/graphs/contributors) |
8 | | - |
9 | 5 | [](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FVirtoCommerce%2Fvc-storefront%2Fmaster%2Fazuredeploy.json) |
10 | 6 |
|
11 | | -Official online shopping website based on [Virto Commerce Platform written on ASP.NET Core](https://virtocommerce.com/microsoft-ecommerce-platform). The website is a client application for VC Platform and uses only public APIs while communicating. |
| 7 | +The Virto Commerce Storefront Kit is the official online shopping website based on the Virto Commerce Platform, written on ASP.NET 8. The website serves as a client application for the VC Platform and communicates solely through public APIs. |
12 | 8 |
|
13 | | -It is possible to run multiple different stores (web sites) on top of Virto Commerce. Each store (website) might have its own theme with a specific layout still being based on the same catalog and customer data. |
| 9 | +The Storefront Kit enables the creation of multiple distinct stores (websites) on top of the Virto Commerce Platform. Each store may have its own theme with specific layouts, yet still be based on the same catalog and customer data. This allows for versatile store configurations, such as: |
14 | 10 |
|
15 | | -It is possible, for example, to create sites with a different design for different product categories still having all products in the same backend. |
| 11 | +* Different designs for various product categories. |
| 12 | +* Regional-specific sites offering tailored product sets. |
| 13 | +* Integration with multiple touchpoints for a true omnichannel experience. |
16 | 14 |
|
17 | | -Another option is to create different sites for different regions so that a specific product set will be available to a specific region, is still based on one product data. |
18 | | - |
19 | | -It is also possible to connect Virto Commerce to multiple touchpoints so that customers will get a real omnichannel experience. |
20 | 15 |
|
21 | 16 | ## Key features |
| 17 | +- Launch and host e-commerce themes on top of the Virto Commerce Platform. |
| 18 | +- XAPI Gateway. |
| 19 | +- Caching mechanism. |
| 20 | +- Multi-store support. |
| 21 | +- Multi-theme support. |
| 22 | +- Server-side rendering. |
| 23 | +And more. |
22 | 24 |
|
23 | | -- Multi-Store support |
24 | | -- Multi-Language support |
25 | | -- Multi-Currency support |
26 | | -- Multi-Themes support |
27 | | -- Faceted search support |
28 | | -- SEO friendly routing |
29 | | -- Server-side rendering |
30 | | -- Client-side rendering |
31 | | -- Optimization for Desktop |
32 | | -- Optimization for Tables |
33 | | -- Optimization for Mobile |
34 | | - |
35 | | -## Business Requirements |
36 | | - |
37 | | -- Home page |
38 | | -- Catalog browsing |
39 | | -- Product page |
40 | | -- Cart |
41 | | -- Bulk add to cart |
42 | | -- Multiple Whish lists and Mark favorites |
43 | | -- Product compare |
44 | | -- Anonymous Checkout process |
45 | | -- Checkout process |
46 | | -- Address verification |
47 | | -- Integration with Tax providers |
48 | | -- Integration Shippment and Payment methods |
49 | | -- Place orders |
50 | | -- Order Approve process |
51 | | -- Offers |
52 | | -- My Account |
53 | | -- My Orders History |
54 | | -- Reorder |
55 | | -- New Account verification |
56 | | -- Self-registration |
57 | | -- Forgot password |
58 | | -- User permissions to manage their own account page |
59 | | -- Catalog personalization |
60 | | -- Price personalization (List and Sales prices) |
61 | | -- Promotions |
62 | | -- Coupons |
63 | | -- Recommended products |
64 | | -- Banner and dynamic content |
65 | | -- User Groups - to build personalization |
66 | | -- Configurable Branding and customization |
67 | | -- Configurable navigation |
68 | | -- CMS to build Static, Landing, Blog pages |
69 | | - |
70 | | -## References |
71 | | - |
72 | | -- [Public Demo](https://st-storefront.demo.govirto.com/) |
73 | | -- Virto Commerce Documentation: <https://www.virtocommerce.com/docs/latest/> |
74 | | -- Home: <https://virtocommerce.com> |
75 | | -- Community: <https://www.virtocommerce.org> |
76 | | -- [Download Latest Release](https://github.com/VirtoCommerce/vc-storefront/releases/latest) |
77 | | - |
78 | | -## Sample themes |
79 | | - |
80 | | -### [B2B theme](https://github.com/VirtoCommerce/vc-theme-b2b-vue) |
81 | | - |
82 | | -View [B2B theme on GitHub](https://github.com/VirtoCommerce/vc-theme-b2b-vue). |
83 | | - |
84 | | - |
| 25 | +## Architecture |
| 26 | +For detailed information about the Virto Storefront Architecture, please refer to our [developer guide](https://docs.virtocommerce.org/storefront/developer-guide/) |
85 | 27 |
|
86 | 28 | ## Technologies and frameworks used |
| 29 | +- ASP.NET 8 |
| 30 | +- ASP.NET Identity Core |
87 | 31 |
|
88 | | -- ASP.NET MVC Core 6.0 on .NET 60 |
89 | | -- ASP.NET Identity Core 3.1.0 |
90 | | -- GraphQL |
91 | | - |
92 | | -## Prerequisites |
93 | | -- Install `vc-platform` 3.x the latest version. [Deploy on Windows](https://github.com/VirtoCommerce/vc-platform/blob/master/docs/getting-started/deploy-from-precompiled-binaries-windows.md) or [Deploy on Linux](https://github.com/VirtoCommerce/vc-platform/blob/master/docs/getting-started/deploy-from-precompiled-binaries-linux.md) |
94 | | -- Install `vc-module-experience-api` module. [Getting started](https://github.com/VirtoCommerce/vc-module-experience-api/blob/dev/docs/getting-started.md) |
95 | | -- Install [vc-module-profile-experience-api](https://github.com/VirtoCommerce/vc-module-profile-experience-api) module. |
96 | | -- Install [Node](https://nodejs.org/en/download/) v.16.X |
97 | | -- Install [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable) package manager |
98 | | - ``` |
99 | | - npm install --global yarn |
100 | | - ``` |
101 | | - |
102 | | -## Continuous Integration Supported by Browserstack |
| 32 | +## Setup |
| 33 | +For detailed setup information, please refer to [Quick Start](https://docs.virtocommerce.org/storefront/developer-guide/getting-started/quickstart-on-windows/) to deploy and run. |
103 | 34 |
|
104 | | -Cross-browser compatibility of the storefront is generously provided by [Browserstack](https://www.browserstack.com/). |
105 | 35 |
|
106 | | -[](http://browserstack.com/) |
| 36 | +## Themes |
107 | 37 |
|
108 | | -## Deploy Storefront |
| 38 | +### B2B Theme |
109 | 39 |
|
110 | | -> If Platform and Storefront are deployed in the same on-premises environment, Storefront should be deployed on different port then Platform. You can do it by `dotnet run CLI` |
111 | | -
|
112 | | -### Install the `vc-storefront` |
113 | | - |
114 | | -- Download [latest release](https://github.com/VirtoCommerce/vc-storefront/releases/latest) and unpack in to a local folder |
115 | | -- Or Clone [https://github.com/VirtoCommerce/vc-storefront](https://github.com/VirtoCommerce/vc-storefront) in to a local folder |
116 | | - |
117 | | -- Open the **appsettings.json** file in a text editor. |
118 | | -- In the **Endpoint** section change **Url**, **UserName**, **Password** with correct path and credentials for Virto Commerce Platform: |
119 | | - |
120 | | -```json |
121 | | -... |
122 | | - "Endpoint": { |
123 | | - "Url": "https://localhost:5001", |
124 | | - "UserName": "admin", |
125 | | - "Password": "store", |
126 | | -``` |
127 | | - |
128 | | -### Setup `B2B Mercury theme` |
129 | | - |
130 | | -```bash |
131 | | -# Clone repo into the folder where storefront is installed |
132 | | -git clone https://github.com/VirtoCommerce/vc-theme-b2b-vue.git "C:\vc-storefront\VirtoCommerce.Storefront\wwwroot\cms-content\themes\{store-name}\default" |
133 | | -# Change the current directory |
134 | | -cd C:\vc-storefront\VirtoCommerce.Storefront\wwwroot\cms-content\themes\{store-name}\default |
135 | | -# install dependencies |
136 | | -yarn |
137 | | -# Start theme in development mode with HMR support |
138 | | -yarn dev |
139 | | -# or build theme to get installable artifact |
140 | | -yarn compress |
141 | | -``` |
| 40 | +View [B2B theme on GitHub](https://github.com/VirtoCommerce/vc-theme-b2b-vue). |
142 | 41 |
|
143 | | -### Run `vc-storefront` application |
| 42 | + |
144 | 43 |
|
145 | | -```bash |
146 | | -# change the current directory |
147 | | -cd C:\vc-storefront\VirtoCommerce.Storefront |
148 | | -# build and run storefront application |
149 | | -dotnet run |
150 | | -# In future, if you don't need to rebuild you can use that |
151 | | -dotnet run --no-build |
152 | | -``` |
153 | 44 |
|
154 | 45 | ### FAQ |
155 | 46 |
|
@@ -187,6 +78,13 @@ To forward the scheme from the proxy in non-IIS scenarios, set `ASPNETCORE_FORWA |
187 | 78 |
|
188 | 79 | For more details on how it works, see the Microsoft [documentation](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/proxy-load-balancer?view=aspnetcore-5.0#forward-the-scheme-for-linux-and-non-iis-reverse-proxies). |
189 | 80 |
|
| 81 | +## References |
| 82 | +- Virto Commerce Documentation: https://docs.virtocommerce.org |
| 83 | +- Home: https://virtocommerce.com |
| 84 | +- Community: https://www.virtocommerce.org |
| 85 | +- [Download Latest Release](https://github.com/VirtoCommerce/vc-storefront/releases/latest) |
| 86 | + |
| 87 | + |
190 | 88 | ## License |
191 | 89 |
|
192 | 90 | Copyright (c) Virto Solutions LTD. All rights reserved. |
|
0 commit comments