GratefulChat

GratefulChat is a Support Chat System for every site

Getting Started

Prerequisites

NodeJS >= ver10
MySQL >= ver5.7
Firebase
AWS CLI

Installing

Before installing, you need to setup NodeJS, MySQL and Web server.

Install required libraries

npm install

Copy and edit config files

Edit configs for your env, after copy from sample.

cp src/server/config/config.json.sample src/server/config/config.json
cp src/client/js/config/config.json.sample src/client/js/config/config.json
cp src/client/js/config/firebase_config.js.sample src/client/js/config/firebase_config.js

Edit server side setting for your environment

// src/server/config/config.json
{
  "port": 8080,
  "session": {
    "secretKey": "secret-key",
    "cookie": {
      "maxAgeHours": 24,
      "secure": false
    }
  },
  "dbs": {
    "mysql": {
      "host": "localhost",
      "port": "3306",
      "user": "username",
      "password": "password",
      "database": "db-name",
      "logging": false
    }
  },

Edit client side setting for your environment

// src/client/js/config/config.json
{
  "domain": "localhost",
  "port": 8080,
  "baseUrl": "/",
  "isSSL": false,
  "siteName": "Sample Site",

Create DB

echo "CREATE DATABASE DB-name DEFAULT CHARACTER SET utf8" | mysql -u user-name -p
mysql -u user-name -p DB-name < data/sql/setup.sql

Firebase setting

You need register and sign in to Firebase, before below settings

Create FIrebase Project

Set project name
Set to use GoogleAnalytics, if you need

Add web app

Choose icon for "Add Web App"

Input app-nickname and push "Register app" button

After registered, push "Next" button

And press "Continue to console" button, then you go back to the project top

Set web app config to client side setting

Press "1 app" label, and press the cog icon of registered Web App

Scroll to "Firebase SDK snippet" section, and select "config" radio button

Copy rows in "const firebaseConfig" object on the source code, and paste to src/client/js/config/firebase_config.js

// src/client/js/config/config.json

const firebaseConfig = {
  // Paste Here!
}

Set web app config to server side setting

Press "Service account" tab on "Settings" page, and press "Generate new private key" button

After downloaded, move the file to "src/server/config/" and rename "firebase-admin-credentials.json"

mv /path-to-downloaded-file src/server/config/firebase-admin-credentials.json

Authentication setting

Open Authentication page.

For Lambda

Create Lambda function for chat bot on AWS Console

Create new function.

Select "Auter from scrach", input "Function name" and select "Node.js 10.x" for Runtime" And push "Create function"

Upload function from local

Before execute this section, you have to setup AWS CLI on your env. Refer to AWS Document

Clone Lex Bot Function from Github, and execute deploy command.

cd /path-to-your-dir
git clone git@github.com:uzura8/gc-support-chat-lex-bot.git
cd gc-support-chat-lex-bot
cp setup.conf.sample setup.conf
vi setup.conf
# Edit for your env
sh deploy.sh

For Amazon Lex

Create Chat Bot

Singn in AWS console, and move to Amazon Lex page.

Put create bot button

Select "Custom bot", and input Bot name, Output voice and COPPA, then push "Create" button.

Create Intent

Push "Create Intent" button

Create Slot to select number like below.

Example

Name: "SelectNum"
Slot type: AMZAON.NUMBER
Prompt: Which number?

In "Fulfillment" section, select "Lambda function" and select your lambda function.
And Build and test.
And publish.

Create IAM User for Amazon Lex

Open AIM page on AWS console and press "Users" link.

Press "Add User" button.

Input "User name" and select "Programatic access" for access type.

Select "Attach existing policies directly", and Check "AmazonLexRunBotsOnly" forPollicy name

Press "Create user" button.

Copy "Access key ID" and "Secret access key" on complete page.

Setup config for AWS

Copy from sample file.

cp src/server/config/aws-config.json.sample src/server/config/aws-config.json
vi src/server/config/aws-config.json

Edit config.
Paste accessKeyId and secretAccessKey.

{
  "lex": {
    "credential": {
      "accessKeyId": "Paste here!",
      "secretAccessKey": "Paste here!",
      "region": "us-west-2"
    },
    "bots": {
      "initialSupport": "GCSupportBot"
    }
  }
}

Build source

npm run build

Create Admin User

node server/create_admin_user.js admin@example.com password 'AdminUser'

Start server

npm run start

uzura8/expressbird