QUICKSTART.md

# 🚀 Quickstart Guide

Get your **AI Digital Library Assistant** up and running in minutes!

## Prerequisites

- **Python 3.10+** installed on your system.
- **OpenAI API Key** (for RAG and summarization).
- **ElevenLabs API Key** (optional, for Voice & Podcast features).

## 🛠️ Installation

1.  **Clone the repository:**
    ```bash
    git clone https://huggingface.co/spaces/YOUR_USERNAME/AiDigitalLibraryAssistant
    cd AiDigitalLibraryAssistant
    ```

2.  **Create a virtual environment (recommended):**
    ```bash
    python -m venv venv
    # Windows
    venv\Scripts\activate
    # Mac/Linux
    source venv/bin/activate
    ```

3.  **Install dependencies:**
    ```bash
    pip install -r requirements.txt
    ```

## ⚙️ Configuration

1.  Create a `.env` file in the root directory:
    ```bash
    touch .env
    ```

2.  Add your API keys to `.env`:
    ```env
    # Required for core features
    OPENAI_API_KEY=sk-your_openai_key_here

    # Required for Voice & Podcast features
    ELEVENLABS_API_KEY=your_elevenlabs_key_here
    ELEVENLABS_AGENT_ID=your_agent_id_here
    ```

## 🏃‍♂️ Running the App

1.  **Start the application:**
    ```bash
    python app.py
    ```

2.  **Open your browser:**
    The app will launch automatically at `http://localhost:7860`.

## 💡 Usage Tips

- **Upload Documents:** Go to the "Library" tab to upload PDF, TXT, or DOCX files.
- **Chat:** Use the "Chat" tab to ask questions about your documents.
- **Voice Mode:** Click "Start Conversation" to talk to your library!
- **Podcast Studio:** Select documents and generate a custom podcast episode.

---
*Built for the MCP-1st-Birthday Hackathon* 🎈