Quickstart Guideยค
10-minute guide to get the AI Chat Application running locally and explore its capabilities.
Overviewยค
This quickstart guide will get you up and running with the complete AI chat system in under 10 minutes. You'll deploy both the backend services and mobile frontend, then explore the key features and architecture.
Target Audience: New contributors, reviewers, demo participants, and evaluators
Prerequisites: Docker or Node.js 18+, npm/yarn, Git, mobile device or emulator
Quick Start Optionsยค
Option 1: Docker (Recommended)ยค
The fastest way to run the complete system with all services:
Services Started: - ๐ Backend API server: http://localhost:5001 - ๐ Prometheus metrics: http://localhost:9090 - ๐ Grafana dashboards: http://localhost:3000 - ๐ Jaeger tracing: http://localhost:16686
Option 2: Local Developmentยค
For active development and debugging:
System Verificationยค
1. Backend Health Checksยค
2. Frontend Verificationยค
Mobile App (Expo): - Open Expo Go app on your mobile device - Scan QR code from terminal/browser - App should load with chat interface
Web Browser (for testing):
- Expo Dev Tools: http://localhost:19002
- Web version: Press w
in terminal
3. Real-time Features Testยค
Chat Functionality: 1. Send a message in the mobile app 2. Observe real-time streaming response 3. Check agent classification (General, Joke, Trivia, etc.) 4. View response validation in dashboard tab
Monitoring & Observability:
1. Grafana Dashboards: http://localhost:3000
- Username: admin
, Password: admin
- View AI validation metrics and system health
-
Prometheus Metrics: http://localhost:9090
- Query validation metrics:
validation_pass_total
- Monitor response times:
http_request_duration_seconds
- Query validation metrics:
-
Jaeger Tracing: http://localhost:16686
- View distributed traces for chat requests
- Analyze agent processing performance
Key Features Demoยค
1. Multi-Agent Intelligenceยค
2. Real-time Validation Dashboardยค
Navigate to the Dashboard tab in the mobile app to see:
- ๐ Response quality scores
- ๐ค Agent performance metrics
- โฑ๏ธ Response time analytics
- ๐ Quality trends over time
3. Enterprise Observabilityยค
Grafana Dashboard Navigation: 1. AI Validation Overview: System-wide validation metrics 2. AI Validation Quality: Detailed quality analysis 3. System Health: Infrastructure monitoring
Key Metrics to Explore:
- Message processing rates
- Agent accuracy scores
- Response validation pass/fail rates
- System performance indicators
Architecture Quick Tourยค
System Componentsยค
graph LR
Mobile[๐ฑ Mobile App<br/>React Native] --> Backend[๐ Backend API<br/>Node.js + Express]
Backend --> Queue[๐ Message Queue<br/>Priority processing]
Backend --> Agents[๐ค AI Agents<br/>Multi-agent system]
Backend --> Validation[โ
Validation<br/>Response quality]
Backend --> Metrics[๐ Metrics<br/>Prometheus]
Metrics --> Grafana[๐ Grafana<br/>Dashboards]
Backend --> Tracing[๐ Tracing<br/>Jaeger]
Key Technologies: - Frontend: React Native + Expo for cross-platform mobile - Backend: Node.js + Express + TypeScript for API services - Real-time: Socket.io for WebSocket communication - AI Integration: OpenAI GPT-4 with intelligent agent routing - Observability: OpenTelemetry + Prometheus + Grafana + Jaeger - Validation: Custom AI response quality assurance system
Data Flow Overviewยค
- User Input: Message sent from mobile app
- Classification: AI agent classifier determines appropriate handler
- Processing: Specialized agent generates contextual response
- Validation: Quality assurance system scores response
- Delivery: Real-time streaming to mobile interface
- Monitoring: Metrics and traces captured for analysis
Next Stepsยค
๐๏ธ Development Setupยค
For detailed development environment setup: โ Complete Setup Guide
๐ง Troubleshootingยค
If you encounter issues during quickstart: โ Troubleshooting Guide
๐๏ธ System Architectureยค
To understand the system design in depth: โ Architecture Overview