Hugging Face's logo

Spaces:
milwright
/
chatui-helper
Running

App Files Community
chatui-helper / README.md
milwright's picture
milwright
Replace Crawl4AI with simple HTTP requests and BeautifulSoup
12839ce
preview code
|
raw
history blame
2.25 kB
metadata
title: Chat UI Helper
emoji: 💻
colorFrom: gray
colorTo: red
sdk: gradio
sdk_version: 5.35.0
app_file: app.py
pinned: true
thumbnail: >-
  https://cdn-uploads.huggingface.co/production/uploads/65a0caa15dfd8b9b1f3aa3d3/8cruZmIioPrYoTN8o-wcE.png
short_description: Configure, download, and deploy a simple chat interface

Chat UI Helper

A Gradio-based tool for generating and configuring chat interfaces for HuggingFace Spaces. Create deployable packages with custom assistants, web scraping capabilities, and optional vector RAG functionality.

Features

Spaces Configuration

  • Custom Assistant Creation: Define role, purpose, audience, and tasks
  • Template System: Choose from research assistant template or build from scratch
  • Tool Integration: Optional dynamic URL fetching and document RAG
  • Access Control: Secure access code protection for educational use
  • Complete Deployment Package: Generates app.py, requirements.txt, README.md, and config.json

Chat Support

  • Expert Guidance: Get personalized help with Gradio configurations
  • Context-Aware: URL grounding for informed responses about HuggingFace Spaces
  • Deployment Assistance: Troubleshooting and best practices

Quick Start

Running Locally 

pip install -r requirements.txt
python app.py

For Chat Support (Optional)

Set your OpenRouter API key as a secret:

  • Go to Settings → Variables and secrets
  • Add secret: OPENROUTER_API_KEY

Generated Space Features

Each generated space includes:

  • OpenRouter API Integration: Support for multiple LLM models
  • Web Scraping: Simple HTTP requests with BeautifulSoup for URL content fetching
  • Document RAG: Optional upload and search through PDF, DOCX, TXT, MD files
  • Access Control: Environment-based student access codes
  • Modern UI: Gradio 5.x ChatInterface with proper message formatting

Architecture

  • Main Application: app.py with two-tab interface
  • Document Processing: RAG pipeline with FAISS vector search
  • Web Scraping: HTTP requests with BeautifulSoup for content extraction
  • Template Generation: Complete HuggingFace Space creation

For detailed development guidance, see CLAUDE.md.