Merge branch 'master' of https://github.com/pragmatismo-io/botserver
This commit is contained in:
commit
5330f3ff0e
4 changed files with 20 additions and 21 deletions
41
README.md
41
README.md
|
@ -1,13 +1,25 @@
|
|||

|
||||
|
||||
|
||||
Welcome to General Bot Community Edition
|
||||
----------------
|
||||
|
||||

|
||||
|
||||
General Bot is a 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?
|
||||
|
||||

|
||||
|
||||
Bot Server accelerates the process of developing a bot. It provisions all code
|
||||
base, resources and deployment to the cloud, and gives you templates you can
|
||||
choose from whenever you need a new bot. The server has a database and service
|
||||
backend allowing you to further modify your bot package directly by downloading
|
||||
a zip file, editing and uploading it back to the server (deploying process) with
|
||||
no code. The Bot Server also provides a framework to develop bot packages in a more
|
||||
advanced fashion writing custom code in editors like Visual Studio Code, Atom or Brackets.
|
||||
|
||||
Everyone can create bots by just copying and pasting some files and using their
|
||||
favorite tools like Excel (or any text editor) or Photoshop (or any image
|
||||
editor).
|
||||
|
@ -18,32 +30,19 @@ Package Quick Reference
|
|||
|----|-----|----|----|
|
||||
|[whatsapp.gblib](https://github.com/pragmatismo-io/BotServer/tree/master/deploy/whatsapp.gblib)|[default.gbui](https://github.com/pragmatismo-io/BotServer/tree/master/deploy/default.gbui)|[core.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/deploy/core.gbapp)|[kb.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/deploy/kb.gbapp)|
|
||||
|
||||
Package Architecture
|
||||
--------------------
|
||||
|
||||

|
||||
|
||||
### What is Bot Server?
|
||||
|
||||
Bot Server accelerates the process of developing a bot. It provisions all code
|
||||
base, resources and deployment to the cloud, and gives you templates you can
|
||||
choose from whenever you need a new bot. The server has a database and service
|
||||
backend allowing you to further modify your bot package directly by downloading
|
||||
a zip file, editing and uploading it back to the server (deploying process) with
|
||||
no code. The Bot Server also provides a framework to develop bot packages in a more
|
||||
advanced fashion writing custom code in editors like Visual Studio Code, Atom or Brackets.
|
||||
### The same build process for everyone
|
||||
|
||||

|
||||
|
||||
### The same build process for everyone
|
||||
|
||||
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.
|
||||
|
||||
|
||||
#### Use Excel for Quick edits
|
||||
#### Use Excel for (Hierarchical) Knowledge Base Editing
|
||||
|
||||

|
||||

|
||||
|
||||
#### Use Visual Studio for a complete .gbai package building system
|
||||
|
||||
|
@ -56,7 +55,7 @@ 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;npm
|
||||
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.
|
||||
|
||||
|
@ -67,7 +66,7 @@ Notes:
|
|||
|
||||
### Configure the server to deploy specific directory
|
||||
|
||||
1. Create/Edit the .env file and add the ADDITIONAL_DEPLOY_PATH key pointing to the local folder of .gbapp, .gbot, .gbtheme, .gbkb, etc. files.
|
||||
1. Create/Edit the .env file and add the ADDITIONAL_DEPLOY_PATH key pointing to the .gbai local parent folder of .gbapp, .gbot, .gbtheme, .gbkb package directories.
|
||||
2. Specify DATABASE_SYNC to TRUE so database sync is run when the server is run.
|
||||
3. In case of Microsoft SQL Server add the following keys: DATABASE_HOST, DATABASE_NAME, DATABASE_USERNAME, DATABASE_PASSWORD, DATABASE_DIALECT to `mssql`.
|
||||
|
||||
|
|
BIN
docs/images/general-bots-composing-subjects-json-and-excel.gif
Normal file
BIN
docs/images/general-bots-composing-subjects-json-and-excel.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.4 MiB |
BIN
docs/images/generalbots-open-core-starting-from-scratch.gif
Normal file
BIN
docs/images/generalbots-open-core-starting-from-scratch.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 27 KiB |
BIN
logo.png
BIN
logo.png
Binary file not shown.
Before Width: | Height: | Size: 2.1 KiB After Width: | Height: | Size: 7.6 KiB |
Loading…
Add table
Reference in a new issue