update readme

README.md

@@ -10,31 +10,124 @@ pinned: false
 license: mit
 ---
 
-# RasaBot + Gradio v4 Demo on HuggingFace Spaces (CPU)
+# RasaBot Local Deployment Instructions
 
-This Space runs a tiny Rasa 2.8.3 assistant inside a **Gradio v4** chat UI on a **CPU** plan.
+This guide provides clear instructions for running the RasaBot locally on your machine. The setup includes two distinct microservices:
 
-## Files
+* **Rasa Main Service** (requires Python 3.8)
+* **Classifier Backend** (requires Python 3.10)
 
-- **Dockerfile**  
-  Python 3.8 → installs Rasa 2.8.3 + Gradio v4 → `rasa init` → `rasa train` → launches `app.py`.
+---
+
+## Prerequisites
+
+* Docker
+* Docker Compose
+
+Ensure Docker and Docker Compose are installed and running on your system.
+
+---
+
+## Directory Structure
+
+Your directory should resemble the following structure:
+
+```text
+RasaBot/
+├── actions/
+│   └── actions.py
+├── app.py
+├── build.sh
+├── classifier/
+│   ├── classifier.py
+│   ├── Dockerfile
+│   └── requirements.txt
+├── config.yml
+├── custom_components/
+│   └── llm_intent_classifier_client.py
+├── data/
+│   ├── nlu.yml
+│   └── rules.yml
+├── Dockerfile
+├── domain.yml
+├── endpoints.yml
+├── envs.sh
+├── models/
+├── README.md
+├── requirements.txt
+├── run_classifier.sh
+└── run_rasa.sh
+```
+
+---
+
+## Build Docker Images
+
+Run the provided build script to build both Docker images:
+
+```bash
+sh build.sh
+```
+
+---
+
+## Run Services
+
+### Run the Classifier Service
+
+Execute the following command:
+
+```bash
+sh run_classifier.sh
+```
+
+This will start the classifier backend service.
+
+### Run the Rasa Main Service
 
-- **requirements.txt**  
-  Pins Rasa and Gradio to v4-compatible versions.
+Execute the following command in a separate terminal:
 
-- **app.py**  
-  Loads the Rasa model and serves a chat UI via Gradio Blocks.
+```bash
+sh run_rasa.sh
+```
 
-- **README.md** (this file)
+This will start the Rasa server along with its Gradio frontend.
 
-## Deploy on HuggingFace Spaces
+---
 
-1. Create a new Space with **Hardware: CPU** and **Environment: Docker**.  
-2. Push these four files to your repo.  
-3. The Space will build, train, and expose the Gradio chat at `/`.
+## Stop the Services
 
-## Local Testing
+To stop the running services, use:
 
 ```bash
-docker build -t rasa-gradio-v4 .
-docker run -it --rm -p 7860:7860 rasa-gradio-v4
+docker-compose down
+```
+
+or press `Ctrl+C` in each terminal running a service.
+
+---
+
+## Access the Chat UI
+
+Once both services are running, open your browser and navigate to:
+
+```
+http://localhost:7860
+```
+
+You can now interact with your RasaBot via the Gradio UI.
+
+---
+
+## Troubleshooting
+
+* Ensure no port conflicts (`7860`, `8000`, `5005`) occur.
+* Verify environment variables in `envs.sh`.
+* Check Docker logs if encountering issues:
+
+```bash
+docker logs <container_name>
+```
+
+---
+