UniqAI/hexabot
1
0
Fork 0
mirror of https://github.com/hexastack/hexabot synced 2024-11-26 21:59:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: updated README

Browse Source
This commit is contained in:
Yassine Sallemi 2024-09-20 18:33:23 +01:00
parent 509dc2381b
commit df0d2320d3
1 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,4 +1,5 @@
# Hexabot # Hexabot
![App Screenshot](https://www.hexabot.ai/assets/images/screencast.gif) ![App Screenshot](https://www.hexabot.ai/assets/images/screencast.gif)
## Description ## Description
@ -20,6 +21,7 @@
- **Inbox & Handover:** Provides a real-time chat window where conversations can be monitored and handed over to human agents when necessary. - **Inbox & Handover:** Provides a real-time chat window where conversations can be monitored and handed over to human agents when necessary.
## Directory Structure ## Directory Structure
- **frontend:** The admin panel built with React/Next.js for managing chatbot configurations and flows. - **frontend:** The admin panel built with React/Next.js for managing chatbot configurations and flows.
- **api:** The backend API built with NestJS and connected to MongoDB for data storage and management. - **api:** The backend API built with NestJS and connected to MongoDB for data storage and management.
- **widget:** A React-based live chat widget that can be embedded into any website to provide real-time interaction. - **widget:** A React-based live chat widget that can be embedded into any website to provide real-time interaction.
@ -27,6 +29,7 @@
- **docker:** A set of Docker Compose files for deploying the entire solution, making it easy to run Hexabot in any environment. - **docker:** A set of Docker Compose files for deploying the entire solution, making it easy to run Hexabot in any environment.
## Prerequisites ## Prerequisites
To ensure Hexabot runs smoothly, you'll need the following: To ensure Hexabot runs smoothly, you'll need the following:
- **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. - **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.
@ -35,28 +38,37 @@ To ensure Hexabot runs smoothly, you'll need the following:
## Installation ## Installation
1. **Clone the Repository:** 1. **Clone the Repository:**
```bash ```bash
$ git clone https://github.com/hexastack/hexabot.git $ git clone https://github.com/hexastack/hexabot.git
``` ```
2. **Environment Setup:** To configure the environment variables, use the Makefile at the root folder for initialization: 2. **Environment Setup:** To configure the environment variables, use the Makefile at the root folder for initialization:
```bash ```bash
$ make init $ make init
``` ```
This will copy the `.env.example` file to `.env` in the `./docker` directory if the file does not already exist. This will copy the `.env.example` file to `.env` in the `./docker` directory if the file does not already exist.
3. **Running the Application:** Once your environment is set up, you can start the app. Use either of the following commands: 3. **Running the Application:** Once your environment is set up, you can start the app. Use either of the following commands:
```bash ```bash
$ make start $ make start
``` ```
or for development mode: or for development mode:
```bash ```bash
$ make dev $ make dev
``` ```
**Note:** The first time you run the app, Docker will take some time to download all the required images. **Note:** The first time you run the app, Docker will take some time to download all the required images.
## Usage ## Usage
UI Admin Panel is accessible via http://localhost:8080, the default credentials are : UI Admin Panel is accessible via http://localhost:8080, the default credentials are :
- **Username:** admin@admin.admin - **Username:** admin@admin.admin
- **Password:** adminadmin - **Password:** adminadmin
@ -65,18 +77,20 @@ Live Chat Widget is accessible via http://localhost:5173
## Commands ## Commands
- `make init` : Copies the .env.example file to .env in the ./docker directory if .env does not exist. This is usually used for initial setup. - `make init` : Copies the .env.example file to .env in the ./docker directory if .env does not exist. This is usually used for initial setup.
- `make dev` : Starts all configured Docker services in development mode. It first checks the .env file for completeness against .env.example. - `make 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.
- `make start` : Similar to dev, but explicitly builds the Docker images before starting the services. This target also checks the .env file for required variables. - `make start` : Starts all configured Docker services by loading all images from Docker Hub. This target also checks the .env file for required variables.
- `make stop` : Stops all running Docker services defined in the compose files. - `make stop` : Stops all running Docker services defined in the compose files.
- `make destroy` : Stops all services and removes all volumes associated with the Docker compose setup, ensuring a clean state. - `make destroy` : Stops all services and removes all volumes associated with the Docker compose setup, ensuring a clean state.
- `make check-env` : Checks if the ./docker/.env file exists and contains all the necessary environment variables as defined in ./docker/.env.example. If the file does not exist, it is created from the example. It also lists missing variables if any. - `make check-env` : Checks if the ./docker/.env file exists and contains all the necessary environment variables as defined in ./docker/.env.example. If the file does not exist, it is created from the example. It also lists missing variables if any.
Example on how to start the stack by adding the Nginx service : Example on how to start the stack by adding the Nginx service :
```sh ```sh
make start NGINX=1 make start NGINX=1
``` ```
## Documentation ## 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). 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: You can also find specific documentation for different components of the project in the following locations:
@ -87,15 +101,16 @@ You can also find specific documentation for different components of the project
- [NLU Engine Documentation](nlu/README.md) - [NLU Engine Documentation](nlu/README.md)
## Contributing ## Contributing
We welcome contributions from the community! Whether you want to report a bug, suggest new features, or submit a pull request, your input is valuable to us. We welcome contributions from the community! Whether you want to report a bug, suggest new features, or submit a pull request, your input is valuable to us.
Please refer to our contribution policy first : [How to contribute to Hexabot](./CONTRIBUTING.md) Please refer to our contribution policy first : [How to contribute to Hexabot](./CONTRIBUTING.md)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](./CODE_OF_CONDUCT.md) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](./CODE_OF_CONDUCT.md)
Feel free to join us on [Discord](https://discord.gg/rNb9t2MFkG) Feel free to join us on [Discord](https://discord.gg/rNb9t2MFkG)
## License ## License
This software is licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms: This software is licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission. 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.