Add Docker Hub deployment documentation and docker-compose configuration

DOCKER.md

@@ -0,0 +1,190 @@
+# Docker Deployment Guide
+
+This guide explains how to deploy Digital Galatea using Docker.
+
+## Quick Start
+
+### Using Pre-built Image from Docker Hub
+
+```bash
+docker run -d \
+  --name digital-galatea \
+  -p 7860:7860 \
+  -e DEEPSEEK_API_KEY=your_deepseek_api_key \
+  -e INFLECTION_AI_API_KEY=your_inflection_api_key \
+  codejedi/digital-galatea:latest
+```
+
+### Using Docker Compose
+
+1. Create a `.env` file with your API keys (see `.env.example`)
+2. Run:
+   ```bash
+   docker-compose up -d
+   ```
+
+## Building the Image
+
+### Build Locally
+
+```bash
+docker build -t digital-galatea:latest .
+```
+
+### Build and Tag for Docker Hub
+
+```bash
+docker build -t codejedi/digital-galatea:latest .
+```
+
+## Publishing to Docker Hub
+
+1. **Login to Docker Hub**
+   ```bash
+   docker login
+   ```
+
+2. **Tag the Image** (if not already tagged)
+   ```bash
+   docker tag digital-galatea:latest codejedi/digital-galatea:latest
+   ```
+
+3. **Push to Docker Hub**
+   ```bash
+   docker push codejedi/digital-galatea:latest
+   ```
+
+4. **Push with Version Tag** (optional)
+   ```bash
+   docker tag digital-galatea:latest codejedi/digital-galatea:v1.0.0
+   docker push codejedi/digital-galatea:v1.0.0
+   ```
+
+## Environment Variables
+
+### Required Variables
+
+- `DEEPSEEK_API_KEY` - Your DeepSeek API key
+- `INFLECTION_AI_API_KEY` - Your Inflection AI API key
+
+### Optional Variables
+
+- `AZURE_TEXT_ANALYTICS_KEY` - Azure Text Analytics key
+- `AZURE_TEXT_ANALYTICS_ENDPOINT` - Azure endpoint URL
+- `ANU_QUANTUM_API_KEY` - Quantum randomness API key
+- `PORT` - Server port (default: 7860)
+
+## Running the Container
+
+### Basic Run
+
+```bash
+docker run -d \
+  --name digital-galatea \
+  -p 7860:7860 \
+  -e DEEPSEEK_API_KEY=your_key \
+  -e INFLECTION_AI_API_KEY=your_key \
+  codejedi/digital-galatea:latest
+```
+
+### With Environment File
+
+```bash
+docker run -d \
+  --name digital-galatea \
+  -p 7860:7860 \
+  --env-file .env \
+  codejedi/digital-galatea:latest
+```
+
+### With Volume for Persistence
+
+```bash
+docker run -d \
+  --name digital-galatea \
+  -p 7860:7860 \
+  -v $(pwd)/data:/app/data \
+  --env-file .env \
+  codejedi/digital-galatea:latest
+```
+
+## Container Management
+
+### View Logs
+
+```bash
+docker logs digital-galatea
+docker logs -f digital-galatea  # Follow logs
+```
+
+### Stop Container
+
+```bash
+docker stop digital-galatea
+```
+
+### Start Container
+
+```bash
+docker start digital-galatea
+```
+
+### Remove Container
+
+```bash
+docker rm digital-galatea
+```
+
+### Restart Container
+
+```bash
+docker restart digital-galatea
+```
+
+## Health Checks
+
+The container includes a health check endpoint. You can verify it's running:
+
+```bash
+curl http://localhost:7860/health
+```
+
+## Troubleshooting
+
+### Container Won't Start
+
+1. Check logs: `docker logs digital-galatea`
+2. Verify environment variables are set correctly
+3. Ensure port 7860 is not already in use
+
+### API Errors
+
+1. Verify API keys are correct
+2. Check network connectivity
+3. Review application logs for specific error messages
+
+### NLTK Data Download
+
+NLTK data is downloaded automatically on first container start. This may take a few minutes. Check logs to see progress.
+
+## Production Considerations
+
+1. **Use Environment Files**: Store sensitive keys in `.env` files (not in version control)
+2. **Resource Limits**: Set appropriate memory and CPU limits
+3. **Restart Policy**: Use `--restart unless-stopped` for automatic restarts
+4. **Health Checks**: Monitor the `/health` endpoint
+5. **Logging**: Configure log rotation and monitoring
+
+Example production run:
+
+```bash
+docker run -d \
+  --name digital-galatea \
+  --restart unless-stopped \
+  -p 7860:7860 \
+  --memory="2g" \
+  --cpus="2" \
+  --env-file .env \
+  codejedi/digital-galatea:latest
+```
+

README.md

@@ -14,7 +14,7 @@ Digital Galatea is a conversational AI with a dynamic emotional model. It featur
 
 ## Features
 
-- **Conversational AI**: Powered by the Google Gemini API for natural and engaging conversations.
+- **Conversational AI**: Powered by DeepSeek and Inflection AI for natural and engaging conversations.
 - **Dynamic Emotional Model**: Simulates five core emotions: Joy, Sadness, Anger, Fear, and Curiosity.
 - **Responsive Avatar**: The AI's visual avatar changes its shape and facial expression based on its dominant emotion.
 - **Sentiment Analysis**: Analyzes user input to dynamically update the AI's emotional state. It uses Azure Text Analytics for high accuracy when configured, with a seamless fallback to a local NLTK VADER model.
@@ -24,33 +24,130 @@ Digital Galatea is a conversational AI with a dynamic emotional model. It featur
 
 - **Backend**: Python, Flask
 - **AI & Machine Learning**:
-  - Google Gemini API
+  - DeepSeek API (Reasoning/Analysis)
+  - Inflection AI (Response Generation)
   - Azure Cognitive Service for Language (Text Analytics)
   - NLTK (VADER)
 - **Frontend**: HTML, CSS, JavaScript
 - **Environment Management**: `python-dotenv`
 
-## Required Setup for Hugging Face Spaces
+## Quick Start with Docker Hub
 
-To run this app on Hugging Face Spaces, you need to set the following **Secret** in your Space settings:
+The easiest way to run Digital Galatea is using the pre-built Docker image from Docker Hub:
 
-### Required Secret
-1. Go to your Space Settings → Repository secrets
-2. Add the following secret:
-   - **Name**: `GEMINI_API_KEY`
-   - **Value**: Your Google Gemini API key from [Google AI Studio](https://ai.google.dev/)
+```bash
+docker pull codejedi/digital-galatea:latest
+docker run -d \
+  --name digital-galatea \
+  -p 7860:7860 \
+  -e DEEPSEEK_API_KEY=your_deepseek_api_key \
+  -e INFLECTION_AI_API_KEY=your_inflection_api_key \
+  -e AZURE_TEXT_ANALYTICS_KEY=your_azure_key \
+  -e AZURE_TEXT_ANALYTICS_ENDPOINT=https://your-resource.cognitiveservices.azure.com/ \
+  codejedi/digital-galatea:latest
+```
+
+Or using docker-compose (see `docker-compose.yml`):
+
+```bash
+docker-compose up -d
+```
+
+Access the application at `http://localhost:7860`
+
+## Environment Variables
+
+### Required Environment Variables
+
+These environment variables **must** be set for the application to function:
+
+| Variable | Description | Where to Get It |
+|----------|-------------|-----------------|
+| `DEEPSEEK_API_KEY` | Your DeepSeek API key for reasoning and analysis | [DeepSeek Platform](https://platform.deepseek.com/) |
+| `INFLECTION_AI_API_KEY` | Your Inflection AI API key for response generation | [Inflection AI](https://inflection.ai/) |
+
+### Optional Environment Variables
+
+These environment variables enhance functionality but are not required:
+
+| Variable | Description | Default Behavior |
+|----------|-------------|------------------|
+| `AZURE_TEXT_ANALYTICS_KEY` | Azure Text Analytics API key for enhanced sentiment analysis | Falls back to NLTK VADER if not provided |
+| `AZURE_TEXT_ANALYTICS_ENDPOINT` | Azure Text Analytics endpoint URL | Required if `AZURE_TEXT_ANALYTICS_KEY` is set |
+| `ANU_QUANTUM_API_KEY` | ANU Quantum Random Numbers API key | Uses pseudo-random numbers if not provided |
+| `PORT` | Port number for the Flask server | Defaults to `7860` |
+
+### Environment Variable Examples
+
+#### Using Docker Run
+
+```bash
+docker run -d \
+  --name digital-galatea \
+  -p 7860:7860 \
+  -e DEEPSEEK_API_KEY=sk-your-deepseek-key \
+  -e INFLECTION_AI_API_KEY=your-inflection-key \
+  -e AZURE_TEXT_ANALYTICS_KEY=your-azure-key \
+  -e AZURE_TEXT_ANALYTICS_ENDPOINT=https://your-resource.cognitiveservices.azure.com/ \
+  codejedi/digital-galatea:latest
+```
+
+#### Using Environment File
+
+Create a `.env` file:
+
+```properties
+# Required
+DEEPSEEK_API_KEY=sk-your-deepseek-key
+INFLECTION_AI_API_KEY=your-inflection-key
+
+# Optional - Enhanced Sentiment Analysis
+AZURE_TEXT_ANALYTICS_KEY=your-azure-key
+AZURE_TEXT_ANALYTICS_ENDPOINT=https://your-resource.cognitiveservices.azure.com/
+
+# Optional - Quantum Randomness
+ANU_QUANTUM_API_KEY=your-quantum-key
 
-### Optional Secrets (for enhanced sentiment analysis)
-- `AZURE_TEXT_ANALYTICS_KEY`: Your Azure Text Analytics key
-- `AZURE_TEXT_ANALYTICS_ENDPOINT`: Your Azure Text Analytics endpoint
+# Optional - Port Configuration
+PORT=7860
+```
 
-If Azure credentials are not provided, the app will automatically use the built-in NLTK VADER sentiment analyzer.
+Then run with:
+
+```bash
+docker run -d --name digital-galatea -p 7860:7860 --env-file .env codejedi/digital-galatea:latest
+```
+
+## Docker Hub
+
+The image is available on Docker Hub:
+
+**Image**: `codejedi/digital-galatea:latest`
+
+```bash
+docker pull codejedi/digital-galatea:latest
+```
+
+### Building and Pushing to Docker Hub
+
+If you want to build and push your own version:
+
+```bash
+# Build the image
+docker build -t codejedi/digital-galatea:latest .
+
+# Login to Docker Hub
+docker login
+
+# Push to Docker Hub
+docker push codejedi/digital-galatea:latest
+```
 
 ## Local Development
 
 1. **Clone the Repository**
    ```bash
-   git clone <repository-url>
+   git clone https://github.com/codejedi-ai/Digital-Galatea.git
    cd Digital-Galatea
    ```
 
@@ -72,10 +169,7 @@ If Azure credentials are not provided, the app will automatically use the built-
 
 4. **Configure Environment Variables**
    - Copy `.env.example` to `.env`
-   - Add your Google Gemini API key:
-   ```properties
-   GEMINI_API_KEY=your_gemini_api_key_here
-   ```
+   - Add your API keys (see Environment Variables section above)
 
 5. **Run the Application**
    ```bash
@@ -86,6 +180,22 @@ If Azure credentials are not provided, the app will automatically use the built-
    - Open your browser and navigate to `http://127.0.0.1:7860`
    - The AI will initialize in the background. Once ready, you can start chatting.
 
+## Deployment Options
+
+### Heroku
+
+The repository includes Heroku configuration files (`Procfile`, `app.json`, `runtime.txt`). 
+
+1. Connect your GitHub repository to Heroku
+2. Set environment variables in Heroku dashboard
+3. Deploy automatically on push to main branch
+
+### Hugging Face Spaces
+
+1. Go to your Space Settings → Repository secrets
+2. Add the required secrets (see Environment Variables section)
+3. The app will build and deploy automatically
+
 ## API Endpoints
 
 The application exposes the following endpoints:
@@ -93,15 +203,16 @@ The application exposes the following endpoints:
 - `GET /`: Serves the main chat interface.
 - `POST /api/chat`: Handles chat messages and returns the AI's response.
 - `GET /api/avatar`: Provides the current avatar shape, emotions, and sentiment for real-time frontend updates.
+- `GET /api/is_initialized`: Check if the system is initialized and ready.
 - `GET /status`: Reports the initialization status of the AI components.
 - `GET /health`: A simple health check endpoint.
 
 ## How It Works
 
 1. **User Input**: You type a message in the chat interface
-2. **Sentiment Analysis**: The system analyzes the emotional tone of your message
+2. **Sentiment Analysis**: The system analyzes the emotional tone of your message using Azure Text Analytics or NLTK VADER
 3. **Emotional Processing**: Galatea's emotional state is updated based on the conversation
-4. **AI Response**: Google Gemini generates a contextual response that reflects Galatea's emotional state
+4. **AI Response**: DeepSeek analyzes the context, and Inflection AI generates a contextual response that reflects Galatea's emotional state
 5. **Avatar Update**: The visual avatar changes shape and expression based on the dominant emotion:
    - **Circle** → High Joy (happy, positive state)
    - **Triangle** → High Sadness (melancholic state)
@@ -110,8 +221,9 @@ The application exposes the following endpoints:
 ## Credits
 
 This project demonstrates the integration of:
-- Google's Gemini API for conversational AI
-- NLTK and Azure for sentiment analysis
+- DeepSeek API for reasoning and analysis
+- Inflection AI for response generation
+- Azure Text Analytics and NLTK for sentiment analysis
 - Real-time emotional modeling
 - Dynamic visual representation of AI state
 

docker-compose.yml

@@ -0,0 +1,30 @@
+version: '3.8'
+
+services:
+  digital-galatea:
+    image: codejedi/digital-galatea:latest
+    container_name: digital-galatea
+    ports:
+      - "7860:7860"
+    environment:
+      # Required - DeepSeek API Key
+      - DEEPSEEK_API_KEY=${DEEPSEEK_API_KEY}
+      # Required - Inflection AI API Key
+      - INFLECTION_AI_API_KEY=${INFLECTION_AI_API_KEY}
+      # Optional - Azure Text Analytics
+      - AZURE_TEXT_ANALYTICS_KEY=${AZURE_TEXT_ANALYTICS_KEY:-}
+      - AZURE_TEXT_ANALYTICS_ENDPOINT=${AZURE_TEXT_ANALYTICS_ENDPOINT:-}
+      # Optional - Quantum API
+      - ANU_QUANTUM_API_KEY=${ANU_QUANTUM_API_KEY:-}
+      # Optional - Port (defaults to 7860)
+      - PORT=${PORT:-7860}
+    env_file:
+      - .env
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:7860/health"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 60s
+