Skip to main content

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

ApplicationPurposeBest ForStart Command
Interactive DemoTry RecoAgent in browserFirst-time users, demoscd apps/demo_ui && python app.py
Production APIRESTful APIProduction deploymentscd apps/api && uvicorn main:app
Analytics DashboardMonitor performanceOperations teamspython apps/analytics_dashboard/app.py
Agent BuilderVisual agent configNo-code userspython apps/agent_builder/app.py
Chainlit UIChat interfaceChatbot applicationscd apps/chainlit_ui && chainlit run app.py
Gradio UIRapid prototypingQuick demos, testingpython apps/gradio_ui/app.py
WorkerBackground processingAsync tasks, scalingcd apps/worker && celery -A worker worker

🚀 Getting Started Path

For First-Time Users

  1. Start here: Interactive Demo - See RecoAgent in action (5 minutes)
  2. Then try: Gradio UI - Customize and experiment (15 minutes)
  3. Finally: Production API - Deploy your solution

For Developers

  1. Start here: Production API - RESTful endpoints
  2. Add monitoring: Analytics Dashboard - Track metrics
  3. Scale up: Worker - Async processing

For Business Users

  1. Start here: Agent Builder - No-code configuration
  2. Test it: Interactive Demo - Validate behavior
  3. Deploy: Chainlit UI - User-friendly chat

📊 Feature Comparison

FeatureDemo UIProd APIAnalyticsAgent BuilderChainlitGradioWorker
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:

🔌 Backend Applications

APIs and Workers

These apps provide programmatic access and background processing:

💡 Use Case Matrix

Choose Your App by Goal

Your GoalRecommended AppAlternative
Demo to stakeholdersInteractive DemoGradio UI
Build a chatbotChainlit UIGradio UI
Deploy to productionProduction API + WorkerChainlit UI
Monitor qualityAnalytics DashboardProduction API metrics
Quick prototypeGradio UIInteractive Demo
No-code agentAgent Builder-
Process large batchesWorkerProduction API
Mobile-friendlyChainlit UIGradio 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

  1. Explore individual app docs - Each app has detailed documentation
  2. Try the Interactive Demo - Best starting point
  3. Read How-To Guides - Learn specific techniques
  4. Check Examples - See code samples

🆘 Getting Help


Ready to start? Try the Interactive Demo first - it takes just 5 minutes! 🚀