botbook/book/chapter-01-index.md

68 lines
2.5 KiB
Markdown

# General Bots - The Bot Server
Welcome to the General Bots Book. This is a reference material that can be used
to understand how the bot server is organized in a form of packages itself and
this arrangement can be used to all custom deployed packages like .gbkb, .gbtheme
or .gbapp.
This book is organized in ten chapters that can be accessed throuhg this table bellow:
* [Acknowledgments](acknowledgments.md)
* [Chapter 01 - The Bot Server ](chapter-01-index.md)
* [Chapter 02 - About Packages](chapter-02-about-packages.md)
* [Chapter 03 - gbkb Reference](chapter-03-gbkb-reference.md)
* [Chapter 04 - gbtheme Reference](chapter-04-gbtheme-reference.md)
* [Chapter 05 - gbdialog Reference](chapter-05-gbdialog-reference.md)
* [Chapter 06 - gbapp Reference](chapter-06-gbappreference.md)
* [Chapter 07 - Administration](chapter-07-administration.md)
* [Chapter 08 - Tooling](chapter-08-tooling.md)
* [Chapter 09 - Services](chapter-09-services.md)
* [Chapter 10 - Contributing](chapter-10-contributing.md)
* [Copyright](copyright.md)
* [Foreward](foreward.md)
* [Glossary](glossary.md)
* [Preface](preface.md)
### 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.
## NLP
## Spell Checker
## Speech to Text
## Omnichannel
## Branding
## Bot Factory