Ratings and Review Add-on

About Addon :

The installation of Spurtcommerce Rating and Review Plugin helps to display the aggregate rating and review for products in the store. When this plugin is installed, the eCommerce site becomes ready for the Customers to post review about the product that they have purchased from the eCommerce store.

Features:

• The Customer can provide a star rating.

• The Customer can also add a comment along with the star rating.

• Vendors and Admin can moderate the reviews.

• Display of Reviews on the Storefront.

• Display of number of 5 stars, 4 stars, 3 stars, 2 stars and 1s star ratings

• Display of aggregate/overall rating.

Frontend Setup - Seller Panel:

Follow these steps to set up the front end for the Rating and Review addon in Spurtcommerce Seller Panel.

Step 1: Install the Addon:

Locate the Spurtcommerce addon package, typically named seller.addOns.zip.

Extract the zip file and copy the RatingAndReview folder into the addOns folder in your project.

projectFolder -> addOns

After this step, the structure should look like:

projectFolder -> addOns -> RatingAndReview

Once completed, proceed to update the configuration.

Step 2: Update the Configuration

After installing the addon, update the add-ons.constant.ts file to include the necessary plugins:

// ----------------------Rating and Review--------------------------
import * as CrmRatingAndReview from './RatingAndReview/RatingandreView.constant'
// components paths
export const CrmRatingAndReviewComponents = CrmRatingAndReview.componentLists;
// route paths
export const CrmRatingAndReviewRoutes = CrmRatingAndReview.routePath;

If you wish to uninstall or remove the Rating and Review addon, replace the component paths and route paths with an empty array.

// ----------------------Rating and Review--------------------------
import * as CrmRatingAndReview from './RatingAndReview/RatingandreView.constant'
// components paths
export const CrmRatingAndReviewComponents = [];
// route paths
export const CrmRatingAndReviewRoutes =[];

Step 3: Run the Application:

To run the application with the integrated Rating and Review addon, use the following command:

$ npm run large-serve

After executing this command, the addon will be available on Spurtcommerce on the designated page.

Step 4: Build the Application

Finally, to prepare the application for deployment, run the build command:

$ npm run large-build

The latest build files will then be ready to deploy to the server.

Frontend Setup - Admin Panel:

Follow these steps to set up the front end for the Rating and Review addon in Spurtcommerce Admin Panel.

Step 1: Install the Addon:

Locate the Spurtcommerce addon package, typically named seller.addOns.zip.

Extract the zip file and copy the RatingAndReview folder into the addOns folder in your project.

projectFolder -> addOns

After this step, the structure should look like:

projectFolder -> addOns -> RatingAndReview

Once completed, proceed to update the configuration.

Step 2: Update the Configuration

After installing the addon, update the add-ons.constant.ts file to include the necessary plugins:

// ----------------------Rating and Review --------------------------
import * as ratingAndReview from './Cms/manage-page/ratingAndReview/rating-review.constant'
// components paths
export const ratingAndReviewComponents = ratingAndReview.ratingAndReviewComponents;
// route paths
export const ratingAndReviewComponentRoutes=ratingAndReview.routePath;

If you wish to uninstall or remove the Rating and Review addon, replace the component paths and route paths with an empty array.

// ----------------------Rating and Review --------------------------
import * as ratingAndReview from './Cms/manage-page/ratingAndReview/rating-review.constant'
// components paths
export const ratingAndReviewComponents = [];
// route paths
export const ratingAndReviewComponentRoutes=[];

Step 3: Run the Application:

To run the application with the integrated Rating and Review addon, use the following command:

$ npm run large-serve

After executing this command, the addon will be available on Spurtcommerce on the designated page.

Step 4: Build the Application

Finally, to prepare the application for deployment, run the build command:

$ npm run large-build

The latest build files will then be ready to deploy to the server.

Store Setup

Next.js

Rating And Review Addon

Follow these steps to set up the Ratings & Reviews module on the front-end Next.js web store.

Setup Overview:

• Install the extension

• Update configuration

• Integrate the module

• Run the application

• Build the application

Step 1: Install the Extension

Locate the Spurtcommerce addon package, typically named addOns.zip.

Extract the zip file and copy the RatingAndReview folder into the addOns folder in your project.

projectFolder -> addOns

After this step, the structure should look like:

projectFolder -> addOns -> RatingAndReview

Once completed, proceed to update the configuration.

Step 2: Update the Configuration

After installing the extension, update the configuration in Spurtcommerce’s addonsconfig.js as follows:

1. Import the required line into addonsconfig.js.

             import ReviewRating from './RatingAndReview/ReviewRating'

1. Add the ReviewRating plugin to the specified object.

export const AddonsComponent = {                                                                                                                                   ReviewRating,                                                                                                                     }  

1. Add the following components to the AddonsComponent object:

ReviewRating

VendorRating

CompareProductRating

OrderDetailAddReview

import ReviewRating from './RatingAndReview/ReviewRating'                                                  import VendorRating from './RatingAndReview/VendorRating'                                import CompareProductRating from'./RatingAndReview/CompareProductRating' import OrderDetailAddReview from './RatingAndReview/OrderAddRating' 

After making these updates, the AddonsComponent object should reflect the new components.

            export const AddonsComponent = {
                  ReviewRating,
                  VendorRating,
                  CompareProductRating,
                  OrderDetailAddReview,
             }

Step 3: Module Details

The Ratings & Reviews module includes the following components that you can utilize in any page within Spurtcommerce by sending the required product data as props:

• OrderDetailAddReview Component

{ConnectPlugin.OrderDetailAddReview && <ConnectPlugin.OrderDetailAddReview orderId={params?.id} />}

Note: Use the OrderDetailAddReview component by passing the product data as a prop:

<connectPlugin.OrderDetailAddReview orderId={params.id} />

Step 4: Run the Application

Once you have integrated the OrderDetailAddReview module, run the application using:

$ npm run dev

This command will launch Spurtcommerce with the integrated Ratings & Reviews module visible on the specified page.

Step 5: Build the Application

To prepare the application for deployment, execute the following command:

$ npm run build

or

$ yarn run build

The latest build files will then be ready for server deployment.

Flutter