UniqAI/hexabot
1
0
Fork 0
mirror of https://github.com/hexastack/hexabot synced 2025-01-22 10:35:37 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
Mohamed Marrouchi 2024-10-27 19:30:37 +01:00
parent 8aa1ea91a3
commit c6555b83a3
1 changed files with 79 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

127
README.md
View File

@ -58,84 +58,73 @@
- **nlu:** The NLU Engine built with Python, enabling intent recognition and language detection through machine learning models.
- **docker:** A set of Docker Compose files for deploying the entire solution, making it easy to run Hexabot in any environment.
## Prerequisites
## Getting Started
To ensure Hexabot runs smoothly, you'll need the following:
### Prerequisites
- **Docker:** We recommend using Docker to start the app since multiple services are required (MongoDB, Redis, Prometheus, etc.). All the necessary Docker Compose files are located in the docker folder.
- **Node.js:** For development purposes, ensure you have Node.js >= v18.17.0 installed. We recommend using nvm (Node Version Manager) to easily manage and update your Node.js versions.
- Node.js >= 18.17.0
- npm (Node Package Manager)
- Docker installed
## Installation
### Installation
1. **Clone the Repository:**
Install Hexabot CLI globally to have easy access to its commands:
```bash
$ git clone https://github.com/hexastack/hexabot.git
```sh
npm install -g hexabot-cli
```
2. **Installation:**
Install node dependencies:
```bash
$ npm install
```
### Usage
3. **Environment Setup:** To configure the environment variables, use the following command at the root folder for initialization:
1. **Create a new project**:
```bash
$ npx hexabot init
```
```sh
hexabot create my-chatbot
```
This will copy the `.env.example` file to `.env` in the `./docker` directory if the file does not already exist.
This will create a new folder `my-chatbot` with all necessary files to get started.
4. **Running the Application:** Once your environment is set up, you can start the app. Use either of the following commands:
2. **Navigate to your project folder**:
```bash
$ npx hexabot start
```
```sh
cd my-chatbot
```
or for development mode:
3. **Install dependencies**:
```bash
$ npx hexabot dev
```
```sh
npm install
```
You can also enable services such as the NLU engine and Ollama (The services are declared under the `./docker` folder) :
4. **Initialize environment**:
```bash
$ npx hexabot dev --enable=ollama,nlu
```
```sh
hexabot init
```
**Note:** The first time you run the app, Docker will take some time to download all the required images.
This command copies the `.env.example` file to `.env`, which you can edit to customize your configuration.
5. **Run in development mode**:
```sh
hexabot dev --services nlu,ollama
```
This starts the required services in development mode.
## Usage
UI Admin Panel is accessible via http://localhost:8080, the default credentials are :
- **Username:** admin@admin.admin
- **Password:** adminadmin
Live Chat Widget is accessible via http://localhost:5173
## Commands
- `npx hexabot init` : Copies the .env.example file to .env in the ./docker directory if .env does not exist. This is usually used for initial setup.
- `npx hexabot dev` : Starts all configured Docker services in development mode. It first checks the .env file for completeness against .env.example and builds the docker images locally.
- `npx hexabot start` : Starts all configured Docker services by loading all images from Docker Hub. This target also checks the .env file for required variables.
- `npx hexabot stop` : Stops all running Docker services defined in the compose files.
- `npx hexabot destroy` : Stops all services and removes all volumes associated with the Docker compose setup, ensuring a clean state.
Example on how to start the stack by adding the Nginx service :
```sh
npx hexabot start --enable=nginx
```
## Documentation
For detailed information on how to get started, as well as in-depth user and developer guides, please refer to our full documentation available in the docs folder or visit the [Documentation](https://docs.hexabot.ai).
You can also find specific documentation for different components of the project in the following locations:
- [CLI Documentation](https://github.com/Hexastack/hexabot-cli/)
- [API Documentation](api/README.md)
- [UI Documentation](frontend/README.md)
- [Live Chat Widget Documentation](widget/README.md)
@ -152,6 +141,48 @@ Please refer to our contribution policy first : [How to contribute to Hexabot](.
Feel free to join us on [Discord](https://discord.gg/rNb9t2MFkG)
1. **Clone the Repository:**
```bash
$ git clone https://github.com/hexastack/hexabot.git
```
2. **Installation:**
Install node dependencies:
```bash
$ npm install
```
3. **Environment Setup:** To configure the environment variables, use the following command at the root folder for initialization:
```bash
$ hexabot init
```
This will copy the `.env.example` file to `.env` in the `./docker` directory if the file does not already exist.
4. **Running the Application:** Once your environment is set up, you can start the app. Use either of the following commands:
For development mode:
```bash
$ hexabot dev
```
Otherwise, you can choose to download docker images rather than building them:
```bash
$ hexabot start
```
You can also enable services such as the NLU engine and Ollama (The services are declared under the `./docker` folder) :
```bash
$ hexabot dev --enable=ollama,nlu
```
**Note:** The first time you run the app, Docker will take some time to download all the required images.
## License
This software is licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms: