Code Monkey home page Code Monkey logo

vsf-freshchat's Introduction

Vue Storefront Freshchat module

Freshchat integration for vue-storefront, by Aureate Labs

This module helps you engage and delight your customers wherever they are - web, mobile and social messengers.

Note: Freschat registration required to use this module into your vue-storefront website. and This module is tested with the Vue storefront version 1.11

Freshchat helps you engage and delight your customers wherever they are - web, mobile and social messengers. There are several useful features with freshchat

  • Reach out wherever they are
  • Automate with bots and AI
  • Engage with proactive campaigns
  • For more feature visit freshchat

Demo

Freshchat documentation: https://developers.freshchat.com/

Installation:

1. Clone the repository

Clone the vsf-freshchat repository into your VSF installation.

$ git clone [email protected]:aureatelabs/vsf-freshchat.git vue-storefront/src/modules/freshchat

2. Add the extension config to your local VSF configuration file.

Add the following JSON config snippet into your desired config, eg. config/local.json

"freshchat" : {
  "token" : "<YOUR_FRESHCHAT_TOKEN>",
  "host": "<YOUR_FRESHCHAT_HOST>"
}

Replace the YOUR_FRESHCHAT_TOKEN & YOUR_FRESHCHAT_HOST parameter with the freshchat token & freshchat host provided by Freshchat after registration. You can find your token & host after login to your freshchat account.

Get Freshchat Script

Valid token example: "token": "dc5a7a7c-cfdd-43ae-9283-5ebb61beeeb6" Valid host example: "host": "https://wchat.freshchat.com"

3. Register the Freshchat module

Open up your ../vue-storefront/src/modules/client.ts and add the following code. Adding it inside this file the registers the extension so it can be used in your Vue Storefront.

  ...
	import { Freshchat } from './freshchat'  /* This is the module name which is we are creating */
	import { registerModule } from '@vue-storefront/core/lib/modules'

	export function registerNewModules () {
		...
		registerModule(Freshchat) /* Register created module which we created in this tutorial */
	}

4. Enjoy!

Thats it! It's easy, plug and play! If you haven't got an Freshchat already, you can create one here, there is free tier that you can use to get started: https://www.freshworks.com/live-chat-software/signup/

Customization

Replacing the Freshchat Script.

If you need to change the Freshchat script that is loaded on the page, open up the ./freshchat/index.ts file. On the freshchatSnippet function. you'll find the script provided from Freshchat, you can swap this out or extend it as required.

License

This project is licensed under the MIT License

vsf-freshchat's People

Contributors

cnviradiya avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

dhendo

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.