botbook/book/chapter-01-Index.md
2019-03-01 15:34:29 -03:00

62 lines
2.3 KiB
Markdown

# General Bots Book
## Package Quick Reference
|Whatsapp|Web|Core|KB|
|----|-----|----|----|
|[whatsapp.gblib](https://github.com/pragmatismo-io/BotServer/tree/master/packages/whatsapp.gblib)|[default.gbui](https://github.com/pragmatismo-io/BotServer/tree/master/packages/default.gbui)|[core.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/packages/core.gbapp)|[kb.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/packages/kb.gbapp)|
### The bot development stack
![General Bot Logo](https://raw.githubusercontent.com/pragmatismo-io/BotServer/master/docs/images/general-bots-stack.png)
### 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;
2. Open a **Terminal** on Linux and Mac or a **Command Prompt** window on Windows;
3. Type `npm install -g botserver` and press *ENTER*;
4. Type `gbot` to run the server core.
Notes:
* [*nodejs.install* Chocolatey Package](https://chocolatey.org/packages/nodejs.install) is also available.
* 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`.
### Just copy the source code to your machine
1. [Download](https://codeload.github.com/pragmatismo-io/BotServer/zip/master) the Zip file.
## Trainning Topics
* Clone BotServer, BotLib repository
* Keyboard centric
* WIN: micro.exe
* Launcher
* dir/ls/ll, cd, mkdir, move
* Npm run build
* npm update -g
* node -v
* SHIFT+PAGE DOWN/UP on Terminal Window
* ncu -a Update all packages in package.json
* npm update -g All NPM package on the system
* Introduction to General Bo
* Environment setup and get the server runni
* KB loading
* NLP and toolin
* Find a NPM package to create a .gbapp that asks for data and output the result
* Visual Studio Code Insiders and plugins
* Run Build Task tsc:watch