diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index e5f624fe..10cf8760 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -53,7 +53,7 @@ ## Developer Guide * [CLI Command Reference](developer-guide/cli-command-reference.md) -* [Developers Installation Guide](developer-guide/developers-installation-guide.md) +* [Contributers Installation Guide](developer-guide/contributers-installation-guide.md) * [Hexabot UI Admin Panel](developer-guide/hexabot-ui-admin-panel.md) * [Hexabot Live Chat Widget](developer-guide/hexabot-live-chat-widget.md) * [Hexabot API](developer-guide/hexabot-api.md) diff --git a/docs/developer-guide/developers-installation-guide.md b/docs/developer-guide/contributers-installation-guide.md similarity index 56% rename from docs/developer-guide/developers-installation-guide.md rename to docs/developer-guide/contributers-installation-guide.md index e1d372da..b11464dc 100644 --- a/docs/developer-guide/developers-installation-guide.md +++ b/docs/developer-guide/contributers-installation-guide.md @@ -1,4 +1,4 @@ -# Developers Installation Guide +# Contributers Installation Guide ## Prerequisites @@ -17,10 +17,12 @@ $ git clone https://github.com/hexastack/hexabot.git 2. **Installation:** -Install node dependencies: +Install Hexabot CLI and node dependencies: ``` -$ git clone https://github.com/hexastack/hexabot.git +$ npm i -g hexabot-cli +$ cd hexabot/ +$ npm i ``` 2. **Environment Setup:** @@ -28,15 +30,15 @@ $ git clone https://github.com/hexastack/hexabot.git To configure the environment variables, use the Makefile at the root folder for initialization: ``` -$ npx hexabot init +$ hexabot init ``` This will copy the `.env.example` file to `.env` in the `./docker` directory if the file does not already exist. -3. **Running the Application in development mode:** Once your environment is set up, you can start the app. Use either of the following commands: +3. **Running the Application in development mode:** Once your environment is set up, you can start the app. Use the following command: ``` -$ npx hexabot dev +$ hexabot dev --enable nlu,widget ``` **Note:** The first time you run the app, Docker will take some time to build all the required Docker images cache the layers. @@ -49,19 +51,3 @@ UI Admin Panel is accessible via [http://localhost:8080](http://localhost:8080), * **Password:** adminadmin Live Chat Widget is accessible via [http://localhost:5173](http://localhost:5173) - - - -### Useful 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` : Builds the Docker images locally before starting the services in development mode. It first checks the .env file for completeness against .env.example. -* `npx hexabot start` : Starts the app by pulling the Docker 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 : - -``` -npx hexabot start --enable=nginx -```