Copy-paste solutions for common ADK (Agent Development Kit) tasks

ADK by Example provides working code examples organized by what you need to accomplish, not by ADK features.

Instead of reading through documentation to understand concepts, find exactly what you need:

• 🔍 "I need my agent to search Google" → Here's the code
• 🔗 "I need to call my REST API" → Copy this example
• 🚢 "I need to deploy to Cloud Run" → Follow these steps
• 🤝 "I need multiple agents working together" → Use this pattern

Think of it as Stack Overflow's best answers, but organized and tested.

Visit https://lavinigam-gcp.github.io/adk-by-example/ to:

• 🔍 Search by what you need: "I want to search Google", "deploy my agent"
• 🌙 Dark mode support: Automatically detects your system preference
• 📱 Mobile-friendly: Responsive design works on all devices
• ⚡ Quick actions: One-click copy for all commands
• ♿ Accessible: WCAG 2.1 AA compliant with keyboard navigation
• 🏷️ Smart filtering: Filter by category and search simultaneously

# Clone the repository
git clone https://github.com/lavinigam-gcp/adk-by-example.git
cd adk-by-example

# Set up your environment
cp .env.example .env
# Edit .env and add your GOOGLE_API_KEY (minimum requirement)

# Navigate to examples directory
cd examples

# Start ADK web interface
adk web

# Select any agent from the dropdown and start chatting!

# Option 1: Copy specific example
cp -r examples/01-getting-started/first-agent ~/my-project/

# Option 2: Use as reference and build your own
cat examples/03-adding-capabilities/search-google/agent.py

# You only need one API key to start
GOOGLE_API_KEY=your-key-here  # Get free at https://aistudio.google.com/app/apikey

See .env.example for all available configuration options.

adk-by-example/
├── examples/                    # All runnable examples
│   ├── 01-getting-started/     # Beginner examples
│   ├── 02-connecting-llms/     # Model integrations
│   ├── 03-adding-capabilities/ # Tools and APIs
│   ├── 04-orchestrating-agents/# Multi-agent patterns
│   ├── 05-managing-context/    # State management
│   ├── 06-going-production/    # Deployment
│   └── 07-advanced-patterns/   # Complex scenarios
├── website/                     # Documentation site
├── scripts/                     # Utility scripts
│   ├── validate_examples.py    # Test all examples
│   └── create_example.py       # Scaffold new example
├── .env.example                # Environment template
└── README.md                   # You are here

1. JTBD-First: Organized by what developers need to do, not by features
2. Copy-Paste Ready: Every example works immediately after cloning
3. Minimal Setup: Single .env file configuration for all examples
4. Real-World Focus: Examples solve actual problems, not toy demos
5. Progressive Learning: Start simple, link to more complex variations
6. Well-Tested: All examples verified with adk web command
7. Grounded in Reality: Every example based on official ADK samples

Problem: "Agent not showing in adk web"

• Solution: Ensure __init__.py exists in the example folder

Problem: "Import errors when running"

• Solution: Run from the examples/ directory, not from individual example folders

Problem: "API key errors"

• Solution: Check .env file exists and contains valid GOOGLE_API_KEY

• 📖 Official ADK Documentation
• 💬 GitHub Issues
• 🌟 Contributing Guide

• Phase 1: Repository structure and foundation (✅ Complete)
• Phase 2: Getting Started category with 6 examples (✅ Complete)
• Phase 3: Production-ready website with advanced search (✅ Complete)
  • JTBD-focused search with smart query processing
  • Dark mode with system preference detection
  • Full accessibility (WCAG 2.1 AA)
  • Mobile-responsive design
  • Category filtering and URL persistence
• Phase 4: 30+ JTBD examples across all 7 categories (23% complete - 7/30)
• Phase 5: Community contributions and integrations
• Phase 6: Video tutorials for complex patterns

We welcome contributions! See CONTRIBUTING.md for guidelines.

Quick contribution ideas:

• 🐛 Report issues with examples
• 📝 Improve documentation
• 🎯 Suggest new JTBD scenarios
• 🔧 Submit your own examples

MIT License - see LICENSE file. Use these examples freely in your projects!

• Built on top of Google's ADK
• Inspired by Go by Example
• Powered by Gemini

Made with ❤️ for the ADK community
⭐ Star this repo if you find it helpful!
🌐 Browse examples online