update project files: add config.json, test_app.py, update app.py, readme, and gitignore

.gitignore

@@ -56,4 +56,7 @@ testing/
 
 # Test files
 test_complete_system.py
-test_grounding.py
+test_grounding.py
+
+# Markdown files
+tts_integration_guide.md

README.md

@@ -89,6 +89,9 @@ Through OpenRouter integration:
 
 ## 📚 Documentation
 
+### [📖 Full Documentation](docs.md)
+Complete step-by-step guide with screenshots and detailed instructions.
+
 The application includes comprehensive built-in documentation:
 - **Step 1**: Configure & Preview Your Space
   - Templates & Identity

app.py

@@ -153,7 +153,8 @@ class SpaceGenerator:
                 self.system_prompt_input = gr.Textbox(
                     label="System Prompt",
                     placeholder="You are a helpful AI assistant...",
-                    lines=5
+                    lines=5,
+                    info="The system prompt that guides the AI's behavior and responses."
                 )
                 
                 self.model_input = gr.Dropdown(
@@ -242,9 +243,9 @@ class SpaceGenerator:
                     add_url_btn = gr.Button("➕ Add URL", size="sm")
                     remove_url_btn = gr.Button("➖ Remove URL", size="sm", visible=False)
             
-            # API Configuration
+            # Environment Variables
             with gr.Group():
-                gr.Markdown("### 🔑 API Configuration")
+                gr.Markdown("### 🔑 Environment Variables")
                 gr.Markdown(
                     "Configure the required secrets in your HuggingFace Space settings."
                 )
@@ -273,7 +274,7 @@ class SpaceGenerator:
                         interactive=False  # Make non-editable
                     )
                 
-                # Instructions without broken images
+                # Instructions
                 with gr.Accordion("📖 Step-by-Step Instructions", open=False):
                     gr.Markdown(
                         """### How to Configure Secrets in HuggingFace Spaces
@@ -288,9 +289,13 @@ class SpaceGenerator:
                         
                         **Step 3: Add Required Secrets**
                         
+                        > 💡 **Visual Guide**: The screenshot below shows the "New secret" dialog where you'll enter your API key:
+                        > ![Adding API Key Secret](img/add-secret-api.png)
+                        
                         Add the following secrets to your Space:
                         
                         1. **API_KEY** - Your OpenRouter API key (required)
+                           - Name: `API_KEY` (exactly as shown)
                            - Get your key at: https://openrouter.ai/keys
                            - Value should start with `sk-or-`
                            - This enables AI responses
@@ -669,9 +674,26 @@ class SpaceGenerator:
                 )
     
     def _create_documentation_tab(self):
-        """Create the documentation tab"""
-        from support_docs import create_support_docs
-        create_support_docs()
+        """Create the documentation tab with external link"""
+        with gr.Column():
+            gr.Markdown("""
+            # 📚 Documentation
+            
+            For detailed instructions on using ChatUI Helper, please refer to our comprehensive documentation.
+            
+            ### 📖 [View Documentation →](docs.md)
+            
+            The documentation includes:
+            - 📖 Quick Start Guide
+            - 📝 Step-by-step configuration instructions
+            - 🗳️ Deployment guide for HuggingFace Spaces
+            - 🔧 Troubleshooting common issues
+            - 📚 Additional resources and links
+            
+            ---
+            
+            **Tip:** You can open the documentation in a new tab to reference it while configuring your Space.
+            """)
     
     def _apply_template(self, template_name, prev_template, cache, 
                         name, tagline, desc, prompt, model, language, temp, tokens, *args):

config.json

@@ -0,0 +1,5 @@
+{
+  "assistant_name": "Test Assistant",
+  "system_prompt": "Test prompt",
+  "model_id": "gemini/gemini-1.5-flash-latest"
+}

test_app.py

@@ -0,0 +1,191 @@
+#!/usr/bin/env python3
+"""Test script for ChatUI Helper application"""
+
+import sys
+import json
+from pathlib import Path
+
+def test_imports():
+    """Test all module imports"""
+    try:
+        from app import SpaceGenerator
+        print("✅ app.py imports successfully")
+        
+        from utils import ConfigurationManager, AVAILABLE_THEMES, fetch_url_content
+        print("✅ utils.py imports successfully")
+        
+        from space_template import get_template, validate_template
+        print("✅ space_template.py imports successfully")
+        
+        from support_docs import create_support_docs
+        print("✅ support_docs.py imports successfully")
+        
+        return True
+    except Exception as e:
+        print(f"❌ Import error: {e}")
+        return False
+
+def test_configuration():
+    """Test configuration management"""
+    try:
+        from utils import ConfigurationManager
+        
+        test_config = {
+            "assistant_name": "Test Assistant",
+            "system_prompt": "Test prompt",
+            "model_id": "gemini/gemini-1.5-flash-latest"
+        }
+        
+        cm = ConfigurationManager(test_config)
+        print("✅ ConfigurationManager initialized")
+        
+        # Test save and load
+        cm.save_config(test_config)
+        loaded = cm.load_config()
+        print("✅ Config save/load works")
+        
+        return True
+    except Exception as e:
+        print(f"❌ Configuration error: {e}")
+        return False
+
+def test_templates():
+    """Test academic templates"""
+    try:
+        with open('academic_templates.json', 'r') as f:
+            templates = json.load(f)
+        
+        print(f"✅ Loaded {len(templates)} academic templates")
+        
+        for name, template in templates.items():
+            required_fields = ['assistant_name', 'tagline', 'system_prompt', 'example_prompts']
+            for field in required_fields:
+                if field not in template:
+                    print(f"❌ Template '{name}' missing field: {field}")
+                    return False
+        
+        print("✅ All templates have required fields")
+        return True
+    except Exception as e:
+        print(f"❌ Template error: {e}")
+        return False
+
+def test_space_template():
+    """Test space template generation"""
+    try:
+        from space_template import get_template, validate_template
+        
+        validate_template()
+        print("✅ Template validation passed")
+        
+        template = get_template()
+        print(f"✅ Template size: {len(template)} characters")
+        
+        # Check for critical placeholders
+        placeholders = [
+            '{assistant_name}',
+            '{system_prompt}',
+            '{model_id}',
+            '{temperature}',
+            '{max_tokens}'
+        ]
+        
+        for placeholder in placeholders:
+            if placeholder not in template:
+                print(f"❌ Missing placeholder: {placeholder}")
+                return False
+        
+        print("✅ All critical placeholders present")
+        return True
+    except Exception as e:
+        print(f"❌ Space template error: {e}")
+        return False
+
+def test_themes():
+    """Test theme availability"""
+    try:
+        from utils import AVAILABLE_THEMES
+        
+        print(f"✅ {len(AVAILABLE_THEMES)} themes available")
+        
+        for name, theme_class in AVAILABLE_THEMES.items():
+            print(f"  - {name}")
+        
+        return True
+    except Exception as e:
+        print(f"❌ Theme error: {e}")
+        return False
+
+def test_docs():
+    """Test documentation files"""
+    try:
+        # Check docs.md exists and has content
+        docs_path = Path('docs.md')
+        if not docs_path.exists():
+            print("❌ docs.md not found")
+            return False
+        
+        content = docs_path.read_text()
+        print(f"✅ docs.md exists ({len(content)} characters)")
+        
+        # Check for images
+        import re
+        img_pattern = r'<img[^>]+src="([^"]+)"'
+        images = re.findall(img_pattern, content)
+        print(f"✅ Found {len(images)} image references in docs.md")
+        
+        # Check image files exist
+        img_dir = Path('img')
+        if img_dir.exists():
+            img_files = list(img_dir.glob('*.png'))
+            print(f"✅ Found {len(img_files)} image files")
+        
+        return True
+    except Exception as e:
+        print(f"❌ Documentation error: {e}")
+        return False
+
+def main():
+    """Run all tests"""
+    print("=" * 50)
+    print("ChatUI Helper Test Suite")
+    print("=" * 50)
+    
+    tests = [
+        ("Imports", test_imports),
+        ("Configuration", test_configuration),
+        ("Templates", test_templates),
+        ("Space Template", test_space_template),
+        ("Themes", test_themes),
+        ("Documentation", test_docs)
+    ]
+    
+    results = []
+    for name, test_func in tests:
+        print(f"\n Testing {name}...")
+        success = test_func()
+        results.append((name, success))
+        print()
+    
+    print("=" * 50)
+    print("Test Results Summary")
+    print("=" * 50)
+    
+    for name, success in results:
+        status = "✅ PASS" if success else "❌ FAIL"
+        print(f"{name:20} {status}")
+    
+    total = len(results)
+    passed = sum(1 for _, s in results if s)
+    
+    print(f"\nTotal: {passed}/{total} tests passed")
+    
+    if passed == total:
+        print("\n🎉 All tests passed!")
+        return 0
+    else:
+        print(f"\n⚠️  {total - passed} test(s) failed")
+        return 1
+
+if __name__ == "__main__":
+    sys.exit(main())