susi_viberbot - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #deep-learning #linux #nodejs #macos #cli #awesome-list #pytorch #ios #openai #open-source

susi_viberbot

(★ 1,476)

Viberbot for SUSI AI http://susi.ai

File Explorer

Download Latest Version (.zip)

- ISSUE_TEMPLATE
- PULL_REQUEST_TEMPLATE
- - branchSelection.png
  - chatSusi.png
  - chooseChatSoln.png
  - configVariables.PNG
  - createHerokuApp.png
  - editAccountDetails.png
  - getPermissionForPA.png
  - herokuDeployment.png
  - herokuGithubConnect.png
  - infoPublicAccount.png
  - Joining_public_ account.png
  - publicAccountKey.png
  - publicAccountSecondScreen.png
  - publicAccoutStartScreen.png
  - publishAccount.png
  - statusMessageForWebhook.png
  - susi.png
  - susiChat.png
  - topRight.png
- - gce-kubernetes.md
- - deploy.sh
  - susi-telegrambot-85cf0ec296e9.json.enc
- deploy.sh
- callPublicChat.js
- jQuery.js
- publicChatForm.html
- style.css
- sample.js
.gitignore
.travis.yml
app.json
Dockerfile
index.js
LICENSE
package.json
Procfile
README.md

# Installation Guide

1. Get the code

git clone https://github.com/fossasia/susi_viberbot

Downloads the entire project code from GitHub to your computer.

cd susi_viberbot

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t susi-viberbot .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 susi-viberbot

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Getting Started : Viber Susi AI Bot Installation

It's easy for you to create your own Viber messenger bot and integrate susi's API into it. You can read the [documentation](https://support.viber.com/customer/en/portal/articles/2554141-create-a-public-account?b_id=13518) on how to make a public account in Viber and get started.

Messenger bots uses a web server to process messages it receives or to figure out what messages to send.

## Prerequisites
To create your account on -:
1. Viber
2. Github
3. Heroku

## Setup your own Messenger Bot
1. Fork this repository.

2. Request for a public account on Viber.

[Fill this form](https://support.viber.com/customer/widget/emails/new?interaction_name=NEWEA)
 
 <img src="./docs/images/getPermissionForPA.png" alt="alt text">
 
 Follow the instructions for verification as indicated by viber.
 
 3. After verification, create and setup the public account.
 
 Click Second button from top-right, to discover public accounts made by you.
 
 <img src="./docs/images/publicAccoutStartScreen.png" alt="alt text" height = '480' width="270">

Click blue button at bottom-right, to create a new one.
 
 <img src="./docs/images/publicAccountSecondScreen.png" alt="alt text" height = '480' width="270">
 
 Click Join Now to start setting it up.
 
 <img src="./docs/images/Joining_public_%20account.png" alt="alt text" height = '480' width="270">
 
 After filling the required details click Continue
 
 <img src="./docs/images/infoPublicAccount.png" alt="alt text" height = '480' width="270">
 
 Add more specific details.
 
 <img src="./docs/images/editAccountDetails.png" alt="alt text" height = '480' width="270">
 
 Select Viber chat Api as your chat Solution.
 
 <img src="./docs/images/chooseChatSoln.png" alt="alt text" height = '480' width="270">
 
 Copy the public account key. (It will be in the area that is coloured gray).
 
 <img src="./docs/images/publicAccountKey.png" alt="alt text" height = '480' width="270">
 
4. Create a new heroku app [here](https://dashboard.heroku.com/new?org=personal-apps).

This app will accept the requests from Viber and Susi api.
 
 <img src="./docs/images/createHerokuApp.png" alt="alt text">

5. Create a config variable by switching to settings page of your app. The name of your config variable should be X_VIBER_AUTH_TOKEN 
   and its value is the API key generated in step 3.

<img src="./docs/images/configVariables.PNG" alt="alt text">

6. Change the url in set webhook request options that is on line 33 in index.js file to https://YOUR-HEROKU-APP-NAME.herokuapp.com enclosed in ' '. Commit and push the changes to this forked repository.

7. Connect the heroku app to the forked repository.
 
 Connect the app to Github by selecting the name of this forked repository.
 
<img src="./docs/images/herokuGithubConnect.png" alt="alt text">

8. Deploy on development branch. If you intend to contribute, it is recommended to Enable Automatic Deploys.

Branch Deployment.
 
<img src="./docs/images/branchSelection.png" alt="alt text">

Successful Deployment.
 
 <img src="./docs/images/herokuDeployment.png" alt="alt text">

9. Now, visit the created heroku app from a browser, and check if the status message received for set Webhook request is - ok. That means the webhook is successfully set.

This should be the output.
 
 <img src="./docs/images/statusMessageForWebhook.png" alt="alt text">

10. Go to the Viber public account created and click the symbol indicating 1-on-1 chat with Susi at your top right(second symbol).
  
 1-on-1 chat
 
<img src="./docs/images/topRight.png" alt="alt text" height = '480' width="270">

11. Enjoy chatting with Susi.

<img src="./docs/images/susiChat.png" alt="alt text" height = '480' width="270">