Product Variant Add-on

Installation of Spurtcommerce Product Variant Add-On

This document will help you to install Product Variant add-on to your spurtcommerce server for single vendor as well as multi vendor

you can install this Add-on through following steps

step 1: Setup an API (Step By Step) to add extension for admin

step 2: Admin setup

step 3: you can easily install admin storefront with store setup. spurtcommerce provides 3 admin storefronts, built with Angular, Flutter and React.

Along with the above steps you need to further follow these steps below to install this Add-on for Multi-vendor platform

step 4: Setup an API (Step By Step) to add extension for multi vendor

step 5 : Multi Vendor front end setup

step 6: you can easily install vendor storefront with store setup. spurtcommerce provides 3 vendor storefronts, built with Angular, Flutter and React.

About Addon:

The Installation of Spurtcommerce Product Variant add-on will enable the feature of adding variant master When the plugin is installed, the multi-Vendor eCommerce site becomes ready for the admin and vendors to add variants under products and get them displayed for the visitors to view different variants in the same product.

Features:

The admin can create a master of variants. E.g., Colour or Size.
The admin can then add different variant values under the variant name. E.g., Under colour, they can add different values like red, green, blue, etc.
When the admin is listing a main product, they can choose different variants available in the masters to list different variants available for the same product.
While listing variants, they can specify different pricing for different variants and also specify the inventory (quantity stock available) for each variant separately.
For each variant under the same product, the SKU prefix followed by a unique number gets allocated. So, each variant under a product will have a unique SKU.
When the Vendor is listing a main product, they can choose different variants available in the variants master list created by the admin, in order to list different variants available for the same product.
While listing variants, they can specify different pricing for different variants and also specify the inventory (quantity stock available) for each variant separately.

Setup an API (Step By Step)

For setting up the API, you need to execute the following steps:

Installing an extension
Run the application
Make the build

Step 1 : Installing an extension

These are the steps that need to be executed for installation of the extension.

Usually spurcommerce comes packed in a zip, whose name ends in "productvariant-addOn.zip". Extract the zip file, open api folder and open addon folder within that and copy the content of addon folder into the specified path

Path - <PROJECT_ROOT>/addon

Step 2 : Run the application

After you have completed the installation of the above mentioned steps, you can run the application and also view the changes.

$ npm start serve

Once you execute the above command, add-on file will get integrated into the backend API.

Step 3 : Make the build

These are the steps that need to be followed for generating the build.

To run the below command

 $ npm run build

Then latest built files can be deployed into the server.

Admin Setup

These are the steps that need to be followed to do the front end admin setup.

Installing an extension
Update the configuration
Module Detail
Run the application
Make the build

Step 1 : Installing an extension

These are the steps that need to be executed for installation of the extension.

Usually spurcommerce comes packed in a zip, whose name ends in "productvariant.addOn.zip".

Extract the zip file and copy the content of admin/add-ons folder into the specified path

Path - admin/add-ons

Note:

1) In add-ons folder if already a catalog folder exists.

Inside cms folder paste productVarient folder.

In catalog routing file(catalog.routing.ts) paste the below code.

export const productVariantRoutes = [
  {
    path: 'product_variant',
    loadChildren: () => import('./ProductVariant/template/product_variant.module').then(m => m.ProductVariantModule),
    canActivate: [AuthGuard],
  },
];
});
];

2) Inside the addon if the catalog folder doesn’t exist.

Paste

Step 2 : Update the configuration

After the installation of the extension, you will have to update certain configurations into the default Spurtcommerce config files. For this, you need to follow the steps below.

Update Reducer Config

Import below line into the add-ons/add-ons-reducer.ts

import * as fromProductVariant from
 './catalog/ProductVariant/core/reducer/productVariant.reducer';

Add the reducer into the below object

  variantList: fromProductVariant.reducer,

After adding its looks like below

export const AddOnReducers: ActionReducerMap<State> = {
    variantList: fromProductVariant.reducer, 
};

Update State Config

Import below line into the add-ons/add-ons-state.ts

 import { ProductVariantState } from                 
  './catalog/ProductVariant/core/reducer/productVariant.state';

Add the state into the below object

variantList: ProductVariantState

After adding its looks like below


export interface AddOnAppState {
    variantList: ProductVariantState;
}

Step 3 : Change the routing file(manageproduct.routing.ts) Inside the src/theme/default/admin/catalog/components/manage-products/manage-products.routing.ts

Import below line

   import * as catalogRouting from'../../../../../../../add-ons/catalog/catalog.routing';

Add these routes below the manageProductsRoute array

 manageProductsRoute.forEach(data => {
 if (data) {
           manageProductsRoute.
           push(catalogRouting.productVariantRoutes[0]);
            }
                                                             });

For setting up the tab add this line in

src/theme/default/admin/catalog/components/header/header.component.html

Below line no:24

<li [appHideIfUnauthorized]="'product-variant'">
                       <a href="#" [routerLink]="['/catalog/manage-products/product_variant/product-list']" [routerLinkActive]="'active'">
                           Product Variants
                       </a>
                   </li>

Step 4 : Filters configurations

Change the routing file (variant-routing.module.ts)

Inside the /add-ons/catalog/ProductVariant/template/variant/variant-routing.module.ts

1) Import below line

import { VariantLayoutComponent } from './variant-layout/variant-layout.component';

Add these routes below the variants array

{

path: 'filters', loadChildren: () =>

import('./filters/filters.module').then(m =>

m.FiltersModule), canActivate: [AuthGuard],

data: { permissionForHeader: 'settings-site-filters', root: 'settingsSite' }

}

For variants up the tab add this line in

/add-ons/catalog/ProductVariant/template/variant/variant-layout/variant-layout.component.html

Below line =13

<button [appHideIfUnauthorized]="'filters'"

[routerLinkActive]="'active'"[routerLink]="[

'/catalog/manage-products/product_variant/variant-settings/filters/list']" routerLinkActive="active" class="tablinks">

Filters

</button>

Step 5 : Run the application

After you have integrated the product attribute Module into Spurtcommerce, you can use the following command to run the application.

 npm run large-serve

Once you execute the above command you can view the installed module in Spurtcommerce, within the page in which you have integrated.

Step 6 : Make the build

To run the below command

 npm run large-build

Then the latest built files can be deployed into the server.

Store Setup

These are the steps that need to be followed to do the front end store setup.

Installing an extension
Update the configuration
Component Detail
Run the application
Make the build

Step 1 : Installing an extension

These are the steps that need to be executed for installation of the extension.

Usually spurcommerce comes packed in a zip, whose name ends in "productvariant.addOn.zip".

Extract the zip file and copy the content of store-angular/add-ons folder into the specified path

Path - store-angular/add-ons

Step 2 : Update the configuration

After the installation of the extension, you will have to update certain configurations into the default Spurtcommerce config files. For this, you need to follow the steps below.

Update Component Config

Import below line into the add-ons/add-ons.shared.component

  import { ControlsVariantComponent } from 
  './ProductVariant/template/controls-variant/controls-variant.component';

Add the following components into the below object

ControlsVariantComponent

After adding its looks like below

export const ADD_ON_COMPONENTS = [ ControlsVariantComponent 
                     ]

Step 3 : Component Detail

The modules pertaining to productsVariants are listed below. You may use these modules, in any page of Spurtcommerce.

In the ProductVariants addon having one components. ControlsVariantComponent

ControlsVariantComponent

Directive

 <app-spurt-controls-variant  [productId]="(productDetail.productDetails$ | async)?.productId" (varPrice)="VarPrice($event)"></app-spurt-controls-variant>

In the above directive have one input field

ProductId:number;

Step 4 : Run the application

After you have integrated the ControlsVariantComponent Module into Spurtcommerce, you can use the following command to run the application.

 ng serve

Once you execute the above command you can view the installed module in Spurtcommerce, within the page in which you have integrated.

Step 5 : Make the build

To run the below command

 ng build –prod

Then the latest built files can be deployed into the server.

These are the steps that need to be followed to do the front end store setup.

Installing an extension
Update the configuration
Module Detail
Run the Application
Make the build

Step 1 : Installing an extension

These are the steps that need to be executed for installation of the extension.

Extract the store-flutter folder inside the folder go to (store-flutter → add-ons → ProductVariant folder) and copy the ProductVariant folder and place the copied folder into the addon folder

Add on location:

projectFolder->lib->add-ons

After placing it it will look like this

projectFolder->lib->add-ons->ProductVariant

Once you finish these steps continue to the next step

Step 2 : Update the configuration

After extracting the add on zip file for changing the configurations in addons.dart, you have to follow the steps below:

Go to

projectFolder->lib->add-ons->addonsshared.dart

Then inside addonsShared array paste the following content

  {"Variant": SpurtProductVariant(), "data":""},

After placing the above files it will look like this

List addonsShared = [

   {"Variant": SpurtProductVariant(), "data":""},
];

Then give the following imports

import 'package:spurtcommerce/addons/ProductVariant/productvariant.dart';

There will be a popup for quick fix

Step 3 : Module detail

After executing the above mentioned steps, we have to place these below lines in the core folder to show the rating and review to the user.

ProductVariant

Once you finished updating the configuration then in the

projectFolder->lib->core->modules->detail->details.dart

file update this line where you seem comfortable with

findMyClass("Variant", {“Id”:details[“productId”]}),

Add this line to your side menu to get blogs section

Step 4 : Run the application

After integrating the Rating and Review Module into Spurt Commerce, you can use the following commands to run the application in terminal.

$ flutter run

Or In Run menu select run without debugging In case if throws any exception

$ flutter run –no-sound-null-safety

Once you execute the above command you can view the installed module in Spurt Commerce, within the page in which you have integrated.

Step 5 : Make the build

In order to build, you need to run the following commands. In order to check the application, run the following commands and build the application.

$flutter build

If you want to split the abi then

$flutter build –split-per-abi

For bundle build

$flutter build appbundle

These are the steps that need to be followed to do the front end store setup.

Installing an extension
Update the configuration
Run the application
Make the build

Step 1 : Installing an extension

These are the steps that need to be executed for installation of the extension.

Usually spurcommerce comes packed in a zip, whose name ends in "productvariant-addOns.zip". Extract the zip file and copy the content of store-react/addOns folder into the specified path as given below

Path -addOns/Varient

Add on location:

projectFolder->addOns

After placing it it will look like this

projectFolder->addOns->Varient

Step 2 : Update the configuration

After the installation of the extension, you will have to update certain configurations into the default Spurtcommerce addonsconfig.js files. For this, you need to follow the steps below.

Once you finish the first Step now declare the necessary plugins in the addonconfig.js file

intoImport below line the addonconfig.js

import SpurtVarientComponent from './Varient/VarientComponent'

Add the VarientComponent into the below object

export const AddonsComponent={
SpurtVarientComponent
}

Step 3 : Module Detail

The modules pertaining to Varient are listed below. You may use these modules, in any page of Spurtcommerce.

SpurtVarientComponent Component:

{ConnectPlugin.SpurtVarientComponent && <ConnectPlugin.SpurtVarientComponent productId={product.productId} />}

Step 4 : Run the application

After you have integrated the Varient Module into Spurtcommerce, you can use the following command to run the application.

$ npm run dev

Once you execute the above command you can view the installed module in Spurtcommerce, within the page in which you have integrated.

Step 5 : Make the build

To run the below command

$ npm run build or yarn nun build

Then the latest built files can be deployed into the server

Setup an API (Step By Step) to add extension for multi vendor

For setting up the API, you need to execute the following steps:

Installing an extension
Run the application
Make the build

Step 1 : Installing an extension

These are the steps that need to be executed for installation of the extension.

Usually spurcommerce comes packed in a zip, whose name ends in "vendorproductvariant-addOn.zip". Extract the zip file and copy the content of api folder into the specified path

Path - <PROJECT_ROOT>/addon

Step 2 : Run the application

After you have completed the installation of the above mentioned steps, you can run the application and also view the changes.

 npm start serve

Once you execute the above command, add-on file will get integrated into the backend API.

Step 3 : Make the build

These are the steps that need to be followed for generating the build.

To run the below command

 npm run build

Then latest built files can be deployed into the server.

Multi vendor frontend Setup

These are the steps that need to be followed to do the front end vendor setup.

Installing an extension
Update the configuration
Module Detail
Run the application
Make the build

Step 1 : Installing an extension

Usually spurcommerce comes packed in a zip, whose name ends in "vendorproductvariant-addOn.zip".

Extract the zip file and copy the content of vendor/add-ons folder into the specified path

Path - vendor/add-ons

Step 2 : Update the configuration

After the installation of the extension, you will have to update certain configurations into the default Spurtcommerce config files. For this, you need to follow the steps below.

Update Reducer Config

Import below line into the add-ons/add-ons-reducer.ts

 import * as fromProductVariant from './ProductVariant/core/reducer/productVariant.reducer';

2. Add the reducer into the below object

variantList: fromProductVariant.reducer

3.After adding its looks like below

export const AddOnReducers: ActionReducerMap<State> = {

variantList: fromProductVariant.reducer

};

Update State Config

Import below line into the add-ons/add-ons-state.ts

   import { ProductVariantState } from "./ProductVariant/core/reducer/productVariant.state";

2. Add the state into the below object

variantList:ProductVariantState;

3. After adding its looks like below

export interface AddOnAppState {

variantList:ProductVariantState;

}

Update Effect Config

Import below line into the add-ons/add-ons.effect.ts

 import { ProductVariantEffect } from "./ProductVariant/core/effect/productVariant.effect";

2. Add the effect into the below object

ProductVariantEffect

After adding its looks like below

export const ADD_ON_EFFECT = [

ProductVariantEffect

];

Update Component Config

Import below line into the add-ons/add-ons.shared.ts

   import { VariantProductListComponent } from "./ProductVariant/template/product-list/list.component";

import { VariantProductAddComponent } from "./ProductVariant/template/product-update/add.component";

Add the following components into the below object

VariantProductListComponent,

VariantProductAddComponent

After adding its looks like below

export const ADD_ON_COMPONENTS = [

VariantProductListComponent,

VariantProductAddComponent

]

Step 3 : Module Detail

The modules pertaining to productvariantlist and productvariantupdate are listed below. You may use these modules, in any page of Spurtcommerce.

Also, you can find the steps below to use the modules in Product Variant in Spurtcommerce pages.

In the ProductVariant addon having two component.

VariantProductListComponent,

VariantProductAddComponent

Routing

In src/app/default/pages/component/calalog/manage-product/manage-product.module.ts

Import below line


      import { VariantProductListComponent } from ../'../../../../../../add-ons/ProductVariant/template/product-list/list.component';

import { VariantProductAddComponent } from '../../../../../../../add-ons/ProductVariant/template/product-update/add.component';

Add these routes below the Routes array

      
             {
                path: 'product-variant-list',
                component: VariantProductListComponent,
                data: {
                    title: 'Variant Products',
                    urls: [{ title: 'Home', url: '/dashboard' }, { title: 'Products', url: '/products/list' }, { title: 'Variant Products' }]
                }
              },
              {
                path: 'product-variant-update/:id',
                component: VariantProductAddComponent,
                data: {
                    title: 'Add Variant Product',
                    urls: [{ title: 'Home', url: '/dashboard' }, { title: 'Products', url: '/products/add' }, { title: 'Add Variant Products' }]
                }
              },

For setting up the tab add this line in

src/app/default/pages/catalog/layout/products.component.html

Below line no:19

  <a href="#" [routerLink]="['/catalog/manage-products/product-variant-list']" class="">Product Variants</a>

Step 4 : Run the application

After you have integrated the ProductVariant Module into Spurtcommerce, you can use the following command to run the application.

 ng serve

Once you execute the above command you can view the installed module in Spurtcommerce, within the page in which you have integrated.

Step 5 : Make the build

To run the below command

	 ng build - -prod

Then the latest built files can be deployed into the server.

Store Setup

These are the steps that need to be followed to do the front end store setup.

Installing an extension
Update the configuration
Component Detail
Run the application
Make the build

Step 1 : Installing an extension

These are the steps that need to be executed for installation of the extension.

Usually spurcommerce comes packed in a zip, whose name ends in "productvariant.addOn.zip".

Extract the zip file and copy the content of api folder into the specified path

Path - <PROJECT_ROOT>/add-ons

Step 2 : Update the configuration

After the installation of the extension, you will have to update certain configurations into the default Spurtcommerce config files. For this, you need to follow the steps below.

Update Component Config

Import below line into the add-ons/add-ons.shared.component

   import { ControlsVariantComponent } from './ProductVariant/template/controls-variant/controls-variant.component';

2. Add the following components into the below object

ControlsVariantComponent

After adding its looks like below

export const ADD_ON_COMPONENTS = [ ControlsVariantComponent

]

Step 3 : Component Detail

The modules pertaining to productsVariants are listed below. You may use these modules, in any page of Spurtcommerce.

In the ProductVariants addon having one components.

ControlsVariantComponent

ControlsVariantComponent Directive

 <app-spurt-controls-variant  [productId]="(productDetail.productDetails$ | async)?.productId" (varPrice)="VarPrice($event)"></app-spurt-controls-variant>

In the above directive have one input field

ProductId:number;

Step 4 : Run the application

After you have integrated the ControlsVariantComponent Module into Spurtcommerce, you can use the following command to run the application.

ng serve

Once you execute the above command you can view the installed module in Spurtcommerce, within the page in which you have integrated.

Step 5 : Make the build

To run the below command

ng build –prod

Then the latest built files can be deployed into the server.

These are the steps that need to be followed to do the front end store setup.

Installing an extension
Update the configuration
Module Detail
Run the Application
Make the build

Step 1 : Installing an extension

These are the steps that need to be executed for installation of the extension.

Extract the vendorproductvariant.zip file and place the extracted files inside the add-ons folder inside the project folder

Add on location:

projectFolder->lib->add-ons

After placing it it will look like this

projectFolder->lib->add-ons->ProductVariant

Once you finish these steps continue to the next step

Step 2 : Update the configuration

After extracting the add on zip file for changing the configurations in addons.dart, you have to follow the steps below:

Go to

projectFolder->lib->add-ons->addonsshared.dart

Then inside addonsShared array paste the following content

  {"Variant": SpurtProductVariant(), "data":""},

After placing the above files it will look like this

List addonsShared = [ {"Variant": SpurtProductVariant(), "data":""},];

Then give the following imports

import 'package:spurtcommerce/add-ons/ProductVariant/productvariant.dart';

There will be a popup for quick fix

Step 3 : Module detail

After executing the above mentioned steps, we have to place these below lines in the core folder to show the rating and review to the user.

ProductVariant

Once you finished updating the configuration then in the projectFolder->lib->core->modules->detail->details.dart file update this line where you seem comfortable with

 findMyClass("Variant", {“Id”:details[“productId”]}),

Add this line to your side menu to get blogs section

Step 4 : Run the application

After integrating the Rating and Review Module into Spurt Commerce, you can use the following commands to run the application in terminal.

$ flutter run

$ flutter run –no-sound-null-safety

Once you execute the above command you can view the installed module in Spurt Commerce, within the page in which you have integrated

Step 5 : Make the build

In order to build, you need to run the following commands. In order to check the application, run the following commands and build the application.

$flutter build

If you want to split the abi then

$flutter build –split-per-abi

For bundle build

$flutter build appbundle

These are the steps that need to be followed to do the front end store setup.

Installing an extension
Update the configuration
Run the application
Make the build

Step 1 : Installing an extension

These are the steps that need to be executed for installation of the extension.

Usually spurcommerce comes packed in a zip, whose name ends in "vendorproductvariant.addOns.zip". Extract the zip file and copy the content of store folder into the specified path as given below

Move Variant folder from addOns/Variant to

Path - <PROJECT_ROOT>/addOns

Add on location:

projectFolder->addOns

After placing it it will look like this

projectFolder->addOns->Variant

Step 2 : Update the configuration

After the installation of the extension, you will have to update certain configurations into the default Spurtcommerce addonsconfig.js files. For this, you need to follow the steps below.

Once you finish the first Step now declare the necessary plugins in the addonconfig.js file

Import below line into the addonconfig.js

import SpurtVarientComponent from 
'./Variant/VariantComponent'

Add the VarientComponent into the below object

export const AddonsComponent={
SpurtVariantComponent
}

Step 3 : Module Detail

The modules pertaining to Variant are listed below. You may use these modules, in any page of Spurtcommerce.

SpurtVariantComponent Component:

{ConnectPlugin.SpurtVariantComponent && <ConnectPlugin.SpurtVariantComponent productId={product.productId} />}

Step 4 : Run the application

After you have integrated the Variant Module into Spurtcommerce, you can use the following command to run the application.

$ npm run dev

Once you execute the above command you can view the installed module in Spurtcommerce, within the page in which you have integrated.

Step 5 : Make the build

To run the below command

$ npm run build or yarn run build

Then the latest built files can be deployed into the server.

NextProduct Attribute Add-on

Last updated 8 months ago