Giter Site home page Giter Site logo

geins-io / ralph-module-hello-retail Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 216 KB

Integrates Hello Retail into your Geins PWA storefront.

Home Page: https://www.geins.io

License: MIT License

JavaScript 89.24% Vue 10.76%
ai ecommerce personalization

ralph-module-hello-retail's Introduction

NPM Package NPM Downloads Geins

Start Geins Free Trial Geins Docs

geins-hello-retail

Hello Retail module for Geins PWA Storefront

A module for Geins PWA Storefront Ralph that allows you to effortlessly integrate Hello Retail features into your storefront. With this module, you can enhance your online store with powerful Hello Retail functionalities in just a few seconds.

Pre-requisites

Description

The Hello Retail module integrates the Hello Retail tracking SDK into your Storefront Ralph.

Hello Retail offers a suite of tools and capabilities that can enhance your online store's performance, improve user experience, and boost conversions.

Installation

To install the Hello Retail module, follow these steps:

1. Install the module

Open your terminal and run the following command:

npm i @geins/ralph-module-hello-retail

2. Add the module to your Geins PWA Storefront Ralph

To add the module to your Geins PWA Storefront Ralph, open your nuxt.config.js file and add the following code snippet:

...
  modules: [
    [
      '@geins/ralph-module-hello-retail',
      {
          enabled: true,
          debug: true,
          trackEvents: true
      }
    ]
  ]

User tracking with Hello Retail

To track user activity on your online store, you need to:

  1. Register your website with Hello Retail. here
  2. Install the Ralph Hello Retail module (see installation above) and publish your site.
  3. Configure your website on Hello Retail. Click Check JavaScript Installation. (Important! This will only work if you have published your site after the installation of this module.).

Once your website has been configured, Hello Retail will start tracking page visitors, assigning each of them to a unique ID (which can later be matched with an e-mail).

In order to track ralph events such as add to cart, viewed product etc, you will need to set the module option trackEvents to true.

The ralph events that will currently be tracked are:

Type of activity Event tracked Information sent
Add to cart User adds a product to the cart Canonical URLs and product IDs for all items in your cart
Remove from cart User removes a product from their cart Canonical URLs and product IDs for all items in your cart
Viewed product User navigates to a product page Canonical URL and product ID

Module Options

Add extra options to module configuration in nuxt.config.js file.

Parameter Default Required Example
enabled true No Enables the module
debug true No Enables debug info to console
trackEvents false No If set to true, ralph events will be tracked

Usage

Once the Hello Retail module is installed and configured, you can start leveraging the power of Hello Retail features in your Geins PWA Storefront Ralph. Explore the various functionalities provided by Hello Retail and integrate them seamlessly into your online store to enhance user experience and drive conversions.

Components (TBA)

  • Search autocomplete
  • Product recommendations

ralph-module-hello-retail's People

Contributors

arvidsson-geins avatar vidarrehn avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.