Skip to content

Handit-AI/interactive-on-boarding

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

1 Commit
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿš€ HandIt Interactive Tour System

An advanced interactive tour system inspired by Layup Labs for HandIt.ai - A comprehensive onboarding and user guidance platform for AI agent improvement.

๐Ÿ“‹ What is this?

This project is a complete implementation of an interactive tour system similar to Layup Labs, specifically designed for HandIt.ai (an automatic AI agent improvement platform). It includes:

  • โœ… Welcome tours with fullscreen modals
  • โœ… Setup wizards with interactive forms
  • โœ… Contextual tooltips for user guidance
  • โœ… Mock components (trace viewers, evaluators, sidebar details)
  • โœ… Fully dynamic JSON configuration
  • โœ… Analytics and event tracking
  • โœ… Responsive design with dark theme
  • โœ… Cursor animations and guided interactions
  • โœ… Persistent sidebar with execution details
  • โœ… 5-step numbered tour flow

๐Ÿš€ How to run the project

Prerequisites

Make sure you have installed:

  • Node.js (version 16 or higher)
  • npm (included with Node.js)

Step 1: Install dependencies

npm install

Step 2: Run in development mode

npm start

The project will automatically open in your browser at: http://localhost:3000

Step 3: Explore the tours!

Once the application is running:

  1. Welcome Tour: Automatically activated when simulating a new user
  2. Setup Wizard: Available after the walkthrough
  3. Evaluator Tour: Activated when simulating SDK integration
  4. Optimizations: Appear when sufficient evaluations exist

๐ŸŽฎ Demo Features

The application includes a complete dashboard with buttons to simulate different states:

Available Simulations:

  • ๐Ÿ”„ Simulate first login โ†’ Activates welcome tour
  • โš™๏ธ Simulate integrated SDK โ†’ Activates evaluator wizard
  • ๐Ÿ“Š Generate evaluation data โ†’ Creates simulated metrics
  • ๐Ÿš€ Simulate optimization โ†’ Shows improvement notifications

Interactive Dashboard:

  • ๐Ÿ“ˆ Real-time metrics (simulated)
  • ๐Ÿ” Traces section with mock data
  • ๐Ÿง  Evaluators panel
  • โšก Optimizations center
  • ๐Ÿ“‹ Execution details sidebar with expandable sections

๐Ÿ“ Project Structure

quickstart/
โ”œโ”€โ”€ public/
โ”‚   โ”œโ”€โ”€ index.html              # Main HTML
โ”‚   โ””โ”€โ”€ manifest.json           # PWA configuration
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ index.js                # React entry point
โ”‚   โ”œโ”€โ”€ index.css               # Global styles
โ”‚   โ”œโ”€โ”€ HandItApp.jsx           # Main application
โ”‚   โ”œโ”€โ”€ HandItApp.css           # Dashboard styles
โ”‚   โ””โ”€โ”€ components/
โ”‚       โ””โ”€โ”€ HandItTour/
โ”‚           โ”œโ”€โ”€ HandItTourProvider.jsx  # Context provider for tours
โ”‚           โ”œโ”€โ”€ TourComponents.jsx      # Tour UI components
โ”‚           โ”œโ”€โ”€ TourComponents.css      # Component styles
โ”‚           โ”œโ”€โ”€ CursorGuide.jsx         # Cursor animation system
โ”‚           โ”œโ”€โ”€ CursorGuide.css         # Cursor styles
โ”‚           โ””โ”€โ”€ handit-tour-config.json # Complete tour configuration
โ”œโ”€โ”€ package.json                # Dependencies and scripts
โ””โ”€โ”€ README.md                   # This file

๐ŸŽจ Implemented Tours

1. Welcome & Concept Walkthrough (5 Steps)

  • Step 1: Welcome screen with tour introduction
  • Step 2: Tracing exploration with table interaction
  • Step 3: Sidebar execution details (System Prompt, User Prompt, Output)
  • Step 4: Evaluation Suite navigation
  • Step 5: Release Hub exploration

2. Wizard-Guided Setup

  • Agent type selection forms
  • SDK integration code with tabs
  • Wait states for external events

3. Evaluator Setup Wizard

  • Agent type-based recommendations
  • Customizable criteria configuration
  • Auto-attachment to relevant nodes

4. First Optimization Experience

  • Contextual notifications
  • Before/after comparisons
  • Improvement metrics

๐Ÿ–ฑ๏ธ Advanced Cursor Guidance

The tour system features sophisticated cursor animations:

  • Curved path animations between elements
  • Click animations with visual feedback
  • Glow highlights on target elements
  • Smart positioning of instruction bubbles
  • Auto-advance functionality with user interaction

๐Ÿ“‹ Sidebar Component

Interactive execution details sidebar featuring:

  • Expandable sections for System Prompt, User Prompt, and Output
  • JSON syntax highlighting for structured data
  • Dark theme styling matching the interface
  • Persistent functionality (works outside tour mode)
  • Multiple selector strategies for robust element detection

โš™๏ธ JSON Configuration

The entire system is controlled from src/components/HandItTour/handit-tour-config.json:

{
  "tourConfig": {
    "tours": [...],           // Tour definitions with step numbers
    "triggers": {...},        // Activation conditions  
    "dynamicContent": {...},  // Personalizable content
    "analytics": {...}        // Event tracking
  }
}

Key Configuration Features:

  • Step numbering (1-5) for easy identification
  • Cursor guidance with animation paths and delays
  • Instruction positioning relative to targets
  • Interactive elements with click/hover actions
  • Multi-language support (currently English)

๐Ÿ”ง Customization

Change Themes:

Edit colors in handit-tour-config.json:

"theme": {
  "primaryColor": "#6366f1",
  "backgroundColor": "rgba(0, 0, 0, 0.7)"
}

Add New Tours:

  1. Define the tour in tours array
  2. Add trigger in triggers
  3. Create steps with actions and step numbers
  4. Customize dynamic content

Modify Mock Components:

Edit TourComponents.jsx to change:

  • MockTraceViewer - Trace visualization
  • MockEvaluationPanel - Evaluation panels
  • MockSidebar - Execution details sidebar

๐Ÿ“ฑ Responsive Design

  • โœ… Desktop - Complete experience
  • โœ… Tablet - Modal adaptations
  • โœ… Mobile - Mobile-optimized tours

๐ŸŽฏ Integrated Analytics

The system automatically tracks:

  • โ–ถ๏ธ Tour starts
  • โœ… Step completions
  • โญ๏ธ Tours skipped
  • ๐Ÿ”„ Time spent on each step
  • ๐Ÿ–ฑ๏ธ Action clicks
  • ๐Ÿ“Š User interaction patterns

๐Ÿ”— Available Scripts

npm start          # Development (port 3000)
npm run build      # Production build  
npm test           # Run tests
npm run eject      # Expose configuration (not recommended)

๐ŸŒŸ Key Features

  • Completely configurable via JSON
  • Templating system for dynamic content
  • Realistic mock components for demos
  • State management with React Context
  • Smart triggers based on conditions
  • Smooth animations and transitions
  • Accessibility (keyboard, screen readers)
  • Integrated analytics for optimization
  • Cursor guidance system with path animations
  • Persistent sidebar with execution details
  • Step-by-step numbered flow

๐Ÿš€ Getting Started

npm install && npm start

The tour will automatically begin when you open the application! ๐ŸŽ‰

๐Ÿ”„ Tour Flow

  1. Welcome Screen โ†’ Start tour
  2. Tracing Section โ†’ Click to explore traces
  3. Table Interaction โ†’ Click on execution to open sidebar
  4. Sidebar Exploration โ†’ Expand System/User Prompts and Output
  5. Evaluation Suite โ†’ Navigate to quality checks
  6. Release Hub โ†’ Explore AI optimization system

๐Ÿ“š Inspiration

This project is inspired by Layup Labs and specifically designed for the onboarding needs of AI platforms like HandIt.ai.

๐ŸŽฏ Development Notes

  • Cursor animations use curved paths with configurable durations
  • Instruction bubbles position dynamically near target elements
  • Event listeners include cleanup to prevent memory leaks
  • State management uses functional updates to avoid closure issues
  • Debug functions available in browser console (window.showMockSidebar())

Built with React, Context API, and advanced CSS animations for HandIt.ai

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published