Merge branch 'main' of https://github.com/GeneralBots/BotServer into main
This commit is contained in:
Rodrigo Rodriguez
commit
284cdac428
2 changed files with 93 additions and 19 deletions
112
README.md
112
README.md
|
|
@ -1,7 +1,19 @@
|
|||
### Key Facts
|
||||
- LLM Orchestrator AGPL licensed (to use as custom-label SaaS, contributing back)
|
||||
- True community governance
|
||||
- No single corporate control
|
||||
- 5+ years of stability
|
||||
- Never changed license
|
||||
- Enterprise-grad
|
||||
- Hosted locally or Multicloud
|
||||
|
||||
## Contributors
|
||||
|
||||
<a href="https://github.com/generalbots/botserver/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=generalbots/botserver" />
|
||||
</a>
|
||||
|
||||
## Overview
|
||||
|
||||
| Area | Status |
|
||||
|------------------------------|----------------------------------------------------------------------------------------------------|
|
||||
|
|
@ -9,17 +21,16 @@
|
|||
| Community | [](https://stackoverflow.com/questions/tagged/generalbots) [](https://badges.frapsoft.com) [](http://makeapullrequest.com) [](https://github.com/GeneralBots/BotServer/blob/master/LICENSE.txt)|
|
||||
| Management | [](https://gitHub.com/GeneralBots/BotServer/graphs/commit-activity) |
|
||||
| Security | [](https://snyk.io/test/github/GeneralBots/BotServer) |
|
||||
| Building & Quality | [](https://app.travis-ci.com/github/GeneralBots/BotServer) [](https://coveralls.io/github/GeneralBots/BotServer) [](https://github.com/prettier/prettier) |
|
||||
| Packaging | [](https://badge.fury.io) [](https://github.com/GeneralBots/BotServer/releases/latest) [](https://david-dm.org) [](http://commitizen.github.io/cz-cli/) |
|
||||
| Samples | [VBA](https://github.com/GeneralBots/BotServer/tree/master/packages/default.gbdialog) or [](https://github.com/GeneralBots/AzureADPasswordReset.gbapp)
|
||||
| [Docker Image](https://github.com/lpicanco/docker-botserver) |      <br/> *Provided by [@lpicanco](https://github.com/lpicanco/docker-botserver)* |
|
||||
| Building & Quality | [](https://coveralls.io/github/GeneralBots/BotServer) [](https://github.com/prettier/prettier) |
|
||||
| Packaging | [](https://badge.fury.io) [](http://commitizen.github.io/cz-cli/) |
|
||||
| Samples | [BASIC](https://github.com/GeneralBots/BotServer/tree/master/packages/default.gbdialog) or [](https://github.com/GeneralBots/AzureADPasswordReset.gbapp)
|
||||
| [Docker Image](https://github.com/lpicanco/docker-botserver)  <br/> *Provided by [@lpicanco](https://github.com/lpicanco/docker-botserver)* |
|
||||
|
||||
General Bots
|
||||
------------------
|
||||
# General Bots
|
||||
|
||||
|
||||
)
|
||||
|
||||
General Bot is a strongly typed package based chat bot server focused in convention over configuration and code-less approaches, which brings software packages and application server concepts to help parallel bot development.
|
||||
General Bot is a strongly typed LLM conversational platform package based chat bot server focused in convention over configuration and code-less approaches, which brings software packages and application server concepts to help parallel bot development.
|
||||
|
||||
## What is a Bot Server?
|
||||
|
||||
|
|
@ -33,9 +44,78 @@ advanced fashion writing custom code in editors like Visual Studio Code, Atom or
|
|||
|
||||
Everyone can create bots by just copying and pasting some files and using their
|
||||
favorite tools from Office (or any text editor) or Photoshop (or any image
|
||||
editor). BASIC can be used to build custom dialogs so Bot can be extended just like VBA for Excel (currently in alpha).
|
||||
editor). LLM and BASIC can be mixed used to build custom dialogs so Bot can be extended just like VBA for Excel.
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before you embark on your General Bots journey, ensure you have the following tools installed:
|
||||
|
||||
- **Node.js (version 20 or later)**: General Bots leverages the latest features of Node.js to provide a robust and efficient runtime environment. Download it from [nodejs.org](https://nodejs.org/en/download/).
|
||||
- **Git (latest stable version)**: Essential for version control and collaborating on bot projects. Get it from [git-scm.com](https://git-scm.com/downloads).
|
||||
|
||||
### Quick Start Guide
|
||||
|
||||
Follow these steps to get your General Bots server up and running:
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone https://github.com/GeneralBots/BotServer
|
||||
```
|
||||
This command creates a local copy of the General Bots server repository on your machine.
|
||||
|
||||
2. Navigate to the project directory:
|
||||
```bash
|
||||
cd BotServer
|
||||
```
|
||||
This changes your current directory to the newly cloned BotServer folder.
|
||||
|
||||
3. Install dependencies and start the server:
|
||||
```bash
|
||||
npm install
|
||||
npm run start
|
||||
```
|
||||
The `npm install` command installs all necessary dependencies for the project. `npm run start` builds your bot server locally and serves it through a development server.
|
||||
|
||||
### Accessing Your Bot
|
||||
|
||||
Once the server is running, you can access your bot at `http://localhost:4242/`. This local server allows you to interact with your bot and test its functionality in real-time. If you want to publish
|
||||
without password, define [ADMIN_OPEN_PUBLISH](https://github.com/GeneralBots/BotBook/master/docs/chapter-07-gbot-reference#enviroment-variables-reference) as true in BotServer .env file.
|
||||
|
||||
To publish bot packages and initiate a conversation with the bot, use the command:
|
||||
|
||||
```
|
||||
/publish
|
||||
```
|
||||
This command prepares your bot packages for use and allows you to start interacting with your bot immediately.
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### 1. Project Structure
|
||||
|
||||
The General Bots server follows a modular architecture designed for flexibility and scalability. Here's an overview of the main directories:
|
||||
|
||||
```
|
||||
BotServer/
|
||||
├── packages/
|
||||
│ ├── core.gbapp/ # Core bot functionality
|
||||
│ ├── kb.gbapp/ # Knowledge base packages
|
||||
├── src / # Main entry point
|
||||
└── package.json # Project configuration
|
||||
```
|
||||
|
||||
This structure allows for easy navigation and management of different aspects of your bot project.
|
||||
|
||||
### 2. Creating Custom Packages
|
||||
|
||||
One of the strengths of General Bots is its extensibility. You can create custom packages to enhance your bot's capabilities:
|
||||
|
||||
- **.gbkb (Knowledge Base packages)**: Store and manage your bot's knowledge and responses.
|
||||
- **.gbtheme (Theme packages)**: Customize the visual appearance of your bot interface.
|
||||
- **.gbapp (Application packages)**: Add new features and functionalities to your bot.
|
||||
|
||||
Each package type has its own structure and purpose, which we'll explore in depth in their respective chapters.
|
||||
|
||||
## Samples
|
||||
|
||||
|
|
@ -67,18 +147,12 @@ SEND FILE img
|
|||
|
||||
## Guide
|
||||
|
||||
[Read the General Bots BotBook Guide](https://github.com/GeneralBots/BotBook/tree/master/book).
|
||||
[Read the General Bots BotBook Guide](https://docs.pragmatismo.cloud)
|
||||
|
||||
# Videos
|
||||
|
||||
Now with the General Bots server you can press F5 on Visual Studio to get a bot factory on your environment* published on November 10th, 2018.
|
||||
|
||||
[](https://www.youtube.com/watch?v=AfKTwljoMOs)
|
||||
|
||||
See how easy is to use 'hear' and 'talk' to build Microsoft BOT Framework v4 logic with plain BASIC * published on December 3rd, 2018.
|
||||
|
||||
[](https://www.youtube.com/watch?v=yX1sF9n9628)
|
||||
|
||||
7 AI General Bots LLM Templates for Goodness
|
||||
[https://www.youtube.com/watch?v=KJgvUPXi3Fw](https://www.youtube.com/watch?v=KJgvUPXi3Fw)
|
||||
|
||||
# Contributing
|
||||
|
||||
|
|
|
|||
BIN
logo.png
Normal file
BIN
logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Loading…
Add table
Reference in a new issue