botbook/book/chapter-01-run-and-talk.md

87 lines
3.1 KiB
Markdown
Raw Normal View History

2019-03-04 12:15:36 -03:00
# General Bots - Run and Talk to the Bot
2019-03-01 15:34:29 -03:00
### The bot development stack
![General Bot Logo](https://raw.githubusercontent.com/pragmatismo-io/BotServer/master/docs/images/general-bots-stack.png)
2020-09-28 16:58:10 -03:00
2020-09-29 09:16:42 -03:00
### Diagram Description
2020-09-28 16:58:10 -03:00
2020-09-30 10:36:33 -03:00
1. gbapp and gblib extensions which are folder extensions for the GeneralBots package type.
2020-09-28 17:20:05 -03:00
gbapp and gblib are responsible for GeneralBots services in a Back-end development environment.
2020-09-30 10:36:33 -03:00
Four components builds up a General Bot App: dialogs, models, services and tests;
2020-09-28 17:20:05 -03:00
2020-09-30 10:36:33 -03:00
2. The .gbui extension is assigned to the GeneralBots front-end development environment.
Angular, Riot, React and HTML are responsible for the dynamic functioning of GeneralBots services;
2020-09-28 16:58:10 -03:00
2020-09-30 10:36:33 -03:00
3. The .gtheme extension is responsible for the GeneralBots designer using css and PS technologies.
A theme is composed of some CSS files and images;
2020-09-29 09:23:13 -03:00
2020-09-30 10:36:33 -03:00
4. The .gbDialog is extension responsible for GeneralBots communication with the end user. Dialogues are bot services to users.
.gbkb is package for execution of various types of media;
2020-09-29 09:16:42 -03:00
2020-09-30 10:36:33 -03:00
5. The .gbot extension refers to the generalBots service product;
2020-09-29 09:36:08 -03:00
2020-09-30 10:36:33 -03:00
6. The .gbai is architecture construction of the GeneralBots application.
2020-09-29 09:36:08 -03:00
2019-03-01 15:34:29 -03:00
### The Bot Factory
![General Bots Block Architecture](https://raw.githubusercontent.com/pragmatismo-io/BotServer/master/docs/images/general-bots-block-architecture.png)
GeneralBots aims to delivery bots in azure in a very easy and fast fashion. Use Office tools like Word or Excel to edit your Bot - using code (JavaScript or TypeScript) just to empower custom requirements.
## How To
### Run the server locally
1. Install [Node.js](https://www.npmjs.com/get-npm) the current generation General Bot code execution platform;
2020-09-29 11:36:26 -03:00
2. Open a **Terminal** on Linux and Mac or a **Command Prompt** and PowerShell window on Windows;
2019-03-01 15:34:29 -03:00
3. Type `npm install -g botserver` and press *ENTER*;
4. Type `gbot` to run the server core.
2020-09-29 11:37:30 -03:00
##Instalation by PowerShell or Command Prompt
2020-09-29 11:36:56 -03:00
2020-09-29 11:33:30 -03:00
![print instalation npm](https://user-images.githubusercontent.com/65977273/94572520-81e2f380-0247-11eb-9d69-ff70ad26b027.png)
2020-09-29 10:39:34 -03:00
2019-03-01 15:34:29 -03:00
Notes:
2020-09-29 09:46:30 -03:00
* [*nodejs.install* Chocolatey Package](https://chocolatey.org/packages/nodejs.install) is also available. (Chocolatey is windows package manager).
2019-03-01 15:34:29 -03:00
* The zip source code of General Bot is also available for [Download](https://codeload.github.com/pragmatismo-io/BotServer/zip/master);
### Running unit tests
1. Enter the BotServer root folder.
2. Run tests by `npm test`.
2020-09-29 15:06:46 -03:00
##Test by PowerShell
2020-09-29 15:07:30 -03:00
2020-09-29 15:06:46 -03:00
![npm test](https://user-images.githubusercontent.com/65977273/94598386-3e977d80-0265-11eb-93e8-ca3013c3f1e1.png)
2019-03-01 15:34:29 -03:00
### Just copy the source code to your machine
1. [Download](https://codeload.github.com/pragmatismo-io/BotServer/zip/master) the Zip file.
2020-09-29 15:24:52 -03:00
## Omnichannel
Omnichannel allow the conversation to follow a sequence, regardless of whether the customer uses the same channel or not, because all calls record the consumer's history and profile.
2020-09-29 15:30:39 -03:00
## Spell Checker
2020-09-29 15:24:52 -03:00
2020-09-29 15:30:39 -03:00
Spell checker is when GeneralBots spell-checks text to find and correct any typographical errors.
## Speech to Text
2020-09-29 15:32:58 -03:00
User speech recognition directly with generalBots.
## Branding
2019-03-01 15:34:29 -03:00
2020-10-01 14:36:48 -03:00
Means software brand.
2020-10-01 14:36:22 -03:00
## NLP
## Bot Factory