Applications Overview
RecoAgent includes 7 production-ready applications that you can run immediately. Each app serves a specific purpose and can be used standalone or as part of your deployment strategy.
🎯 Quick Navigation
Application | Purpose | Best For | Start Command |
---|---|---|---|
Interactive Demo | Try RecoAgent in browser | First-time users, demos | cd apps/demo_ui && python app.py |
Production API | RESTful API | Production deployments | cd apps/api && uvicorn main:app |
Analytics Dashboard | Monitor performance | Operations teams | python apps/analytics_dashboard/app.py |
Agent Builder | Visual agent config | No-code users | python apps/agent_builder/app.py |
Chainlit UI | Chat interface | Chatbot applications | cd apps/chainlit_ui && chainlit run app.py |
Gradio UI | Rapid prototyping | Quick demos, testing | python apps/gradio_ui/app.py |
Worker | Background processing | Async tasks, scaling | cd apps/worker && celery -A worker worker |
🚀 Getting Started Path
For First-Time Users
- Start here: Interactive Demo - See RecoAgent in action (5 minutes)
- Then try: Gradio UI - Customize and experiment (15 minutes)
- Finally: Production API - Deploy your solution
For Developers
- Start here: Production API - RESTful endpoints
- Add monitoring: Analytics Dashboard - Track metrics
- Scale up: Worker - Async processing
For Business Users
- Start here: Agent Builder - No-code configuration
- Test it: Interactive Demo - Validate behavior
- Deploy: Chainlit UI - User-friendly chat
📊 Feature Comparison
Feature | Demo UI | Prod API | Analytics | Agent Builder | Chainlit | Gradio | Worker |
---|---|---|---|---|---|---|---|
Web UI | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ❌ |
REST API | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
No Code | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ❌ |
Production Ready | ❌ | ✅ | ✅ | ❌ | ✅ | ❌ | ✅ |
Authentication | ❌ | ✅ | ✅ | ❌ | ✅ | ❌ | ✅ |
Metrics | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ |
Chat Memory | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | ❌ |
Scalable | ❌ | ✅ | ✅ | ❌ | ✅ | ❌ | ✅ |
🎨 UI Applications
Visual Interfaces
These apps provide graphical user interfaces for different use cases:
- Interactive Demo - Flask-based demo with Q&A, evaluation, and metrics
- Analytics Dashboard - Streamlit dashboard for monitoring
- Agent Builder - Visual tool for configuring agents
- Chainlit UI - Modern chat interface with memory
- Gradio UI - Simple interface for rapid prototyping
🔌 Backend Applications
APIs and Workers
These apps provide programmatic access and background processing:
- Production API - FastAPI REST API with OpenAPI docs
- Worker - Celery worker for async tasks
💡 Use Case Matrix
Choose Your App by Goal
Your Goal | Recommended App | Alternative |
---|---|---|
Demo to stakeholders | Interactive Demo | Gradio UI |
Build a chatbot | Chainlit UI | Gradio UI |
Deploy to production | Production API + Worker | Chainlit UI |
Monitor quality | Analytics Dashboard | Production API metrics |
Quick prototype | Gradio UI | Interactive Demo |
No-code agent | Agent Builder | - |
Process large batches | Worker | Production API |
Mobile-friendly | Chainlit UI | Gradio UI |
🏗️ Architecture Overview
🔧 Installation & Setup
Prerequisites
All applications require:
# Clone repository
git clone <repo-url>
cd recoagent
# Install core dependencies
pip install -r requirements.txt
Quick Setup Commands
# Interactive Demo
cd apps/demo_ui
pip install -r requirements.txt
export OPENAI_API_KEY="your-key"
python app.py
# Production API
cd apps/api
pip install -r requirements.txt
uvicorn main:app --reload
# Analytics Dashboard
cd apps/analytics_dashboard
pip install -r requirements.txt
streamlit run app.py
# Agent Builder
cd apps/agent_builder
pip install -r requirements.txt
python app.py
# Chainlit UI
cd apps/chainlit_ui
pip install -r requirements.txt
chainlit run app.py
# Gradio UI
cd apps/gradio_ui
pip install -r requirements.txt
python app.py
# Worker
cd apps/worker
pip install -r requirements.txt
celery -A worker worker -l info
📚 Next Steps
- Explore individual app docs - Each app has detailed documentation
- Try the Interactive Demo - Best starting point
- Read How-To Guides - Learn specific techniques
- Check Examples - See code samples
🆘 Getting Help
- Documentation: Each app has detailed docs (see sidebar)
- Troubleshooting: Check Troubleshooting Guide
- Support: Contact support@recohut.com
- Issues: Report on GitHub
Ready to start? Try the Interactive Demo first - it takes just 5 minutes! 🚀