update readme

.env.example

@@ -1,5 +1,21 @@
 # Local development environment variables - rename to .env
-SAMBANOVA_API_KEY =your_api_key_here
-MISTRAL_API_KEY =your_api_key_here
-NEBIUS_API_KEY =your_api_key_here 
-AUDIO_GENERATION_URL =your_api_key_here
+
+# Used for story generation and text manipulation
+SAMBANOVA_API_KEY="your-sambanova-api-key-here"
+MISTRAL_API_KEY ="your-mistral-api-key-here"
+MISTRAL_MODEL="your-mistral-model-here"
+
+# used for image generation models
+NEBIUS_API_KEY="your-nebius-api-key-here"
+NEBIUS_ENDPOINT="your-nebius-endpoint-here"
+
+# Replace the URLs with your actual Modal hosted Audio model URLs
+AUDIO_GENERATION_URL="your-audio-generation-url-here"
+MELODY_GENERATION_URL="your-melody-generation-url-here"
+
+MCP_SERVER_URL="your-mcp-server-url-here"
+
+#Used to test mcp function calling
+OPENAI_API_KEY="your-openai-api-key-here"
+#Used to Parse the PDFs for story enrichment
+LLAMA_CLOUD_API_KEY="your-llama-cloud-api-key-here"

.gitattributes

@@ -35,3 +35,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.png filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,47 +1,95 @@
 ---
-title: Dynamic Story Generator
-emoji: 📚
-colorFrom: indigo
-colorTo: purple
+title: Magic Tales
+emoji: 🌟
+colorFrom: #e1ebd2
+colorTo: #a7d569
 sdk: gradio
 sdk_version: 5.32.1
 app_file: app.py
-pinned: false
+pinned: True
+thumbnail: assets/images/wizard.png
+description: |
+  Magic Tales is a Gradio application that uses a range of LLMs and tools to create personalized, immersive stories for children. Customize story types, tones, and more to spark imagination and creativity!
+Track: agent-demo-track
+keywords:
+  - gradio
+  - Modal
+  - Nebius
+  - sambanova
+  - mistral
+  - llamaindex
+  - Dia-1.6B
+  - Meta musicGen
+  - stories
+  - children
+  - mcp
+  - interactive
+  - pdf
+  - customization
+  - imagination
+  - creativity
+  - agent-demo-track
+  - mcp-server-track
+repository: agharsallah/magical-tales
 ---
 
-# Dynamic Story Generator
+# 🌟 Magic Tales: Where Imagination Comes Alive! 📚✨
 
-This is a Gradio application that generates stories for kids using the SambaNova API. The app allows users to customize stories based on:
-- Story type (Historical, Futuristic, Fantasy)
-- Tone (Funny, Enthusiastic, Mysterious)
-- Child's age
-- Language preference
-- Child's interests
-- Subject of the story
-- Optional PDF document for additional context
+<p align="center">
+  <a href="https://huggingface.co/spaces/agharsallah/magical-tales">
+    <img src="assets/images/wizard.png" alt="Magic Tales" width="220" style="max-width:100%;height:auto;">
+  </a>
+</p>
 
-## Setup
+Welcome to Magic Tales, a Gradio application that harnesses the power of SambaNova API to craft personalized, immersive stories for children. Our app is designed to spark imagination and creativity, offering a wide array of customization options to suit various tastes and preferences:
 
-### Environment Variables
+🔹 **Story Crafting**: Choose from diverse story types (Historical, Futuristic, Fantasy), tones (Funny, Enthusiastic, Mysterious), and tailor the narrative based on the child's age, language preference, interests, and the subject of the story.
+🔹 **Enhanced Context**: Optionally, upload a PDF document to provide additional context for the story, making it even more personalized and relevant.
+🔹 **Interactive Experience**: Built with Gradio, our application offers an intuitive and interactive user interface, making story generation a delightful experience for both children and parents.
 
-The application requires a SambaNova API key which can be provided in two ways:
-1. Through the Gradio web interface in the "API Settings" section
-2. For environment variable check .env.example, and create a `.env` file in the root 
+## 🚀 Getting Started
 
-When deploying to Hugging Face Spaces, set this as a Secret in the Settings tab.
+### ⚙️ Configuration
 
-### Installation
+You can configure the app using environment variables. For example, to set the SambaNova API key, you can use the `SAMBANOVA_API_KEY` environment variable:
 
-```bash
-pip install -r requirements.txt
-```
+   - Through the Gradio web interface in the "API Settings" section
+   - By creating a `.env` file in the root directory (check `.env.example` for reference)
 
-### Running Locally
+   When deploying to Hugging Face Spaces, set this as a Secret in the Settings tab.
 
-```bash
-python app.py
-```
+See the [Gradio documentation](https://github.com/gradio-app/gradio/blob/main/guides/04_additional-features/10_environment-variables.md#_snippet_20) for more information.
 
-## Deployment
+### 🔧 Setup
 
-This application is designed to work on Hugging Face Spaces. Simply push this repository to a Hugging Face Space and add the `SAMBANOVA_API_KEY` as a Secret in the Space settings.
+1. **Installation**: Run the following command to install the required dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+2. **Running Locally**: Start the application by executing:
+   ```bash
+   python app.py
+   ```
+
+## 🎯 Features
+
+- **🌎 Multi-Language Support**: Generate stories in various languages to cater to a global audience.
+- **🎶 Audio Narration**: Listen to the generated stories with integrated audio narration for an immersive experience.
+- **🎵 Background Music**: Enjoy background music while listening to the stories, enhancing the overall experience.
+- **🎨 Image Generation**: Generate images to accompany the stories, bringing characters and scenes to life.
+- **🖥️ Interactive UI**: User-friendly Gradio interface for seamless story generation.
+- **📄 PDF Context Integration**: Enhance story generation with additional context from uploaded PDF documents.
+- **📝 Customizable Narratives**: Tailor stories based on story type, tone, child's age, language, interests, and subject.
+
+## 🌐 Demo
+
+Experience the magic of our Dynamic Story Generator in action! Check out our live demo [here](https://huggingface.co/spaces/agharsallah/magical-tales).
+
+## 🚀 Deployment
+
+This application is optimized for Hugging Face Spaces. Simply push this repository to a Hugging Face Space and add the `SAMBANOVA_API_KEY` as a Secret in the Space settings.
+
+## 📸 Screenshots
+
+![App Screenshot](assets/demo/magic-story.gif)

app.py

@@ -50,7 +50,11 @@ gr.set_static_paths(paths=[Path.cwd().absolute() / "assets/images"])
 
 def create_app():
     """Create the main Gradio app for Magic Story Creator"""
-    with gr.Blocks(css=main_css, theme=gr.themes.Ocean()) as demo:
+    with gr.Blocks(
+        css=main_css,
+        theme=gr.themes.Ocean(),
+        title="Magic Tales",
+    ) as demo:
         # Header
         create_header()