.gbapp Guide

Introduction

.gbapp is the folder extension for the General Bots Application package type. Anything inside a folder considered a .gbapp will be consumed by the server like a TypeScript application. This conversational application will contain the source code for custom dialogs and behaviour for any .gbot that associate this deployed .gbapp.

A good way to start a .gbapp is to find a NPM package to create a .gbapp that asks for data and output the result. For example, a temperature package can be installed via npm install temperature and then have its methods convertToKelvin or convertToCelsius called when user asks for conversion. A .gbapp can persist and read data from database according to the conversation session.

Preparing Environment

Currently the node version supported is 10.19.0 due to ogg and vorbis libs. Please see the same issue on this address: https://github.com/TooTallNate/node-ogg/issues/27.

Windows

PowerShell Script

Copy and paste on a PowerShell prompt with elavated privileges and when VSCode is opened just press F5 to run the development server.

Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))

cinst git --confirm
cinst nodejs --confirm --version=10.19.0
cinst vscode --confirm
npm install windows-build-tools -g

&"C:\Program Files\Git\bin\git.exe" clone https://github.com/GeneralBots/BotServer.git
cd BotServer
&"C:\Program Files\Microsoft VS Code\bin\code.cmd" .

Manual steps.

[Optional] Install Chocolatey, a Windows Package Manager;
Install git, a Software Configuration Management (SCM);
Install Node.js, a Runtime system;
Install Visual Studio Code Insiders, Brackets or Atom as an editor of your choice;
Fork the repository by visiting https://github.com/pragmatismo-io/BotServer/fork;
Clone the just forked repository by running git clone <your-forked-repository-url>/BotServer.git;
Run the bot server by gbot.cmd.

Required packages


cinst git --confirm
cinst nodejs --confirm
npm install windows-build-tools -g

Optional packages


cinst 7zip.install --confirm
cinst tortoisegit --confirm
cinst winscp --confirm
cinst sysinternals --confirm
cinst putty --confirm
cinst pandoc --confirm
cinst curl --confirm
cinst micro --confirm
cinst ccleaner --confirm
cinst notepadplusplus --confirm
cinst sql-server-management-studio --confirm

node packages


npm install -g npm-check-updates

Specifications

Dialogs

The dialog is built by specifing series of methods, disposed as an array as seen on Figure 1. Each dialog has also an identifier that can be called by several engines like kb.gbapp, which handles cloud based search for documents and other knowledge base information and also routes for the natural language processing (NLP) engine.


static getDialogs(bot: BotAdapter, min: GBMinInstance) {
    return [{name:"/convertTemperature", waterfall: [
        async step => {
        },
        async step => {
        },
        async step => {
        }]
    },{name:"/convertCurrency", waterfall: [
        async step => {
        },
        async step => {
        },
        async step => {
        }]
    }
    ]

*Figure 1 - How to build dialogs in General Bots using TypeScript*

How To...

Debugging .gbapp deployed on Azure

Visit https://.scm.azurewebsites.net/api/vfs/LogFiles/Application/index.html

Tooling

JavaScript

Título	Endereço
	https://deeplearnjs.org/
	Oimo.js http://lo-th.github.io/Oimo.js/#stacking
	js-sequence-diagrams: https://bramp.github.io/js-sequence-diagrams/
	http://blog.avenuecode.com/a-library-for-data-visualization-d3.js
Chrome inside Node.js	https://github.com/GoogleChrome/puppeteer
XLSX loader	https://github.com/mgcrea/node-xlsx
Node.js bindings for CNTK	https://github.com/nadavbar/node-cntk
API Repository	https://any-api.com/
ORM
Migração de .NET para JavaScript (Node.js)	https://www.reddit.com/r/webdev/comments/2val7s/as_a_net_developer_do_i_need_to_care_about_nodejs
Simplified JavaScript Jargon	http://jargon.js.org

Packages

Título	Descrição	URL
MSAL	Microsoft Authentication Library	https://www.npmjs.com/package/msal

Visual Studio Code Extensions

Title	Description
mbinic.tgit-cmds	Set of commands for launching TortoiseGit dialogs
tomashubelbauer.vscode-markdown-table-format	Formats MarkDown tables so that all columns have the same width
esbenp.prettier-vscode	VS Code plugin for prettier/prettier (wraps at column 80)
mikestead.dotenv	.env support
abhinavk99.codewall	Description here
christian-kohler.npm-intellisense	Description here
csholmq.excel-to-markdown-table	Description here
davidanson.vscode-markdownlint	Description here
eg2.ts-tslint	Description here
eg2.vscode-npm-script	Description here
esbenp.prettier-vscode	Description here
formulahendry.auto-rename-tag-	Description here
gruntfuggly.align-mode	Description here
jmfirth.vsc-space-block-jumper	Description here
kaiwood.indentation-level-movement	Description here
mbinic.tgit-cmds	Description here
mechatroner.rainbow-csv	Description here
mikestead.dotenv	Description here
sirtori.indenticator	Description here
tandy.color-basic	Description here

Common tasks

Task	Description
npm update -g	Updates NPM
node -v	Checks node version
ncu -a	Update all packages in package.json

8.9 KiB Raw Blame History