52 lines
1.9 KiB
Markdown
52 lines
1.9 KiB
Markdown
---
|
|
sidebar_position: 0
|
|
---
|
|
|
|
# General Bots Documentation
|
|
|
|
Welcome to the General Bots documentation. 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:
|
|
|
|
* [Chapter 01 - Run and Talk](chapter-01-run-and-talk.md)
|
|
* [Chapter 02 - About Packages](chapter-02-the-package-based.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-gbapp-reference.md)
|
|
* [Chapter 07 - gbot Reference](chapter-07-gbot-reference.md)
|
|
* [Chapter 08 - Tooling](chapter-08-tooling.md)
|
|
* [Chapter 09 - Services](chapter-09-services.md)
|
|
* [Chapter 10 - Contributing](chapter-10-contributing.md)
|
|
* [Apendix I - Database Model](apendix-i-database-model.md)
|
|
* [Glossary](glossary.md)
|
|
|
|
|
|
## Getting Started
|
|
|
|
Get started by **creating a new bot**.
|
|
|
|
Or **[Create Bot](https://gb.pragmatismo.cloud/PROD-GeneralBots006)** with General Bots Online.
|
|
|
|
### What you'll need
|
|
|
|
- [Node.js](https://nodejs.org/en/download/) version 20:
|
|
- [Git](https://nodejs.org/en/download/) version 20:
|
|
|
|
```
|
|
git clone https://github.com/GeneralBots/BotServer
|
|
npm run start
|
|
```
|
|
|
|
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
|
|
|
|
The command also installs all necessary dependencies you need to run Docusaurus.
|
|
|
|
## Navigate to your bot
|
|
|
|
|
|
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:4242/.
|
|
|
|
Type `/publish` to publish bot packages and start talking to the bot.
|