name: product-popularity-plugin title: Product Popularity Plugin description: Vendure plugin designed to expose and query product popularity metrics in your e-commerce store. version: 3.0.0

Product Popularity Plugin

The Product Popularity Plugin is a Vendure plugin designed to expose and query the popularity of products in your e-commerce store. It provides a mechanism to store and retrieve a static popularity metric for products, enabling better decision-making for inventory management, marketing, and promotions.

Functionality

This plugin enables the following features:

• Storing a static popularity metric (popularityInternal) in the database.
• Exposing the popularity metric via the Shop GraphQL API.
• Integrating with ElasticSearch to enable sorting search results by product popularity.

Use Cases

The Product Popularity Plugin is ideal for:

• Displaying a predefined popularity metric for products.
• Sorting search results based on product popularity.
• Supporting marketing campaigns for popular products.

Installation

1. Clone the repository or copy the product-popularity-plugin directory into your project.

2. Navigate to the plugin directory:

   cd packages/product-popularity-plugin

3. Install the dependencies:

   yarn

4. Build the plugin:

   yarn build

5. Add the plugin to your Vendure configuration:

   import { ProductPopularityPlugin } from 'product-popularity-plugin'
   
   export const config = {
     plugins: [
       ProductPopularityPlugin,
       // other plugins
     ],
   }

Usage

1. Start the Vendure server:

   yarn start

2. Access the admin UI at http://localhost:3050/admin and log in with the default credentials (superadmin/superadmin).

3. Use the shop GraphQL API at http://localhost:3050/shop-api to query product popularity data.

Testing

1. Run the end-to-end tests:

   yarn test

2. Modify the tests in test/e2e.spec.ts to suit your plugin's functionality.

Publishing to NPM

1. Ensure you are logged in to NPM.

2. Build the plugin:

   yarn build

3. Publish the plugin:

   yarn publish

Resources

• Vendure Plugin Documentation
• GraphQL Code Generator for generating TypeScript types for custom GraphQL types.