Skip to content

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ยค

The fastest way to run the complete system with all services:

1
2
3
4
5
6
7
8
9
# Clone and navigate to project
git clone <repository-url>
cd <project-directory>

# Start all services with Docker
docker-compose up -d

# Verify services are running
docker-compose ps

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:

# Terminal 1: Backend
cd backend
npm install
npm run dev
# โœ… Backend running on http://localhost:5001

# Terminal 2: Frontend (React Native/Expo)
cd frontend
npm install
npm start
# โœ… Expo Dev Tools opens in browser
# ๐Ÿ“ฑ Use Expo Go app to scan QR code

System Verificationยค

1. Backend Health Checksยค

# API Health Check
curl http://localhost:5001/api/health

# Expected Response:
# {
#   "status": "OK",
#   "timestamp": "2024-01-01T12:00:00.000Z",
#   "version": "1.0.0"
# }

# View API Documentation
open http://localhost:5001/docs  # Interactive Swagger UI

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

  1. Prometheus Metrics: http://localhost:9090

    • Query validation metrics: validation_pass_total
    • Monitor response times: http_request_duration_seconds
  2. Jaeger Tracing: http://localhost:16686

    • View distributed traces for chat requests
    • Analyze agent processing performance

Key Features Demoยค

1. Multi-Agent Intelligenceยค

# Test different agent types by sending these messages:

# Joke Agent
"Tell me a funny joke"

# Trivia Agent  
"What's an interesting fact about space?"

# Technical Support Agent
"I'm having trouble with my account login"

# GIF Agent
"Show me a celebration gif"

# D&D Master
"Generate a D&D character"

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ยค

  1. User Input: Message sent from mobile app
  2. Classification: AI agent classifier determines appropriate handler
  3. Processing: Specialized agent generates contextual response
  4. Validation: Quality assurance system scores response
  5. Delivery: Real-time streaming to mobile interface
  6. 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

ยค