fix: add env setup instrucs

Author: pchalasani

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Langroid Chat UI Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -189,7 +189,48 @@ class EventDrivenAgent(lr.ChatAgent):
 ### Prerequisites
 - Python 3.8+
 - Node.js 16+
-- Langroid installed (`pip install langroid`)
+- UV (recommended) or pip for Python package management
+
+### Environment Setup
+
+#### Using UV (Recommended)
+
+UV is a fast Python package manager that handles virtual environments automatically:
+
+```bash
+# Install UV if you haven't already
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Navigate to the backend directory
+cd backend
+
+# Create virtual environment and install dependencies
+uv venv
+uv pip install -r requirements.txt
+
+# Install Langroid
+uv pip install langroid
+```
+
+#### Using pip with venv (Alternative)
+
+```bash
+# Navigate to the backend directory
+cd backend
+
+# Create virtual environment
+python -m venv venv
+
+# Activate virtual environment
+# On macOS/Linux:
+source venv/bin/activate
+# On Windows:
+# venv\Scripts\activate
+
+# Install dependencies
+pip install -r requirements.txt
+pip install langroid
+```
 
 ### Setup
 
@@ -216,8 +257,14 @@ If you prefer to run each component separately or if `run.sh` doesn't work on yo
 1. **Backend** (in one terminal):
    ```bash
    cd backend
-   pip install -r requirements.txt
-   python main.py
+   
+   # If using UV:
+   uv run python main.py
+   
+   # If using venv:
+   # source venv/bin/activate  # On macOS/Linux
+   # venv\Scripts\activate     # On Windows
+   # python main.py
    ```
 
 2. **Frontend** (in another terminal):

run.sh

@@ -19,7 +19,16 @@ sleep 2
 # Start backend
 echo -e "${BLUE}Starting backend server...${NC}"
 cd backend
-python main.py &
+
+# Check if UV is available and use it if present
+if command -v uv &> /dev/null; then
+    echo "Using UV to run backend..."
+    uv run python main.py &
+else
+    echo "UV not found, using Python directly..."
+    python main.py &
+fi
+
 BACKEND_PID=$!
 echo "Backend PID: $BACKEND_PID"