README

Transform your Magento admin experience with AI-powered configuration help. Get instant, intelligent explanations for any configuration field with a simple click.

✨ Features

• 🎯 Smart Help Icons - [?] icons appear next to every configuration field
• 🤖 AI-Powered Explanations - Real-time explanations using Google Gemini or OpenAI
• 📱 Beautiful UI - Professional modal popups with smooth loading animations
• 🔒 Secure - Encrypted API key storage with proper validation
• 📊 Comprehensive Logging - Full request/response logging for debugging
• 🆓 Free Options - Google Gemini integration with generous free tier
• ⚡ Performance Optimized - Minimal overhead, efficient code structure
• 🎨 Admin-Friendly - Seamlessly integrates with Magento's admin interface

🚀 Installation

Via Composer (Recommended)

composer require minsarai/magento2-ai-admin-assistant
php bin/magento module:enable Minsar_AdminAssistant
php bin/magento setup:upgrade
php bin/magento cache:flush

Manual Installation

1. Download and extract to app/code/Minsar/AdminAssistant/
2. Run installation commands above

🔧 Configuration

1. Navigate to Stores → Configuration → Minsar → Admin Assistant
2. Enable the module
3. Choose your AI provider:
   • Google Gemini (Free - No credit card required)
   • OpenAI GPT-3.5 (Free $5 credit for new accounts)
4. Add your API key
5. Save configuration

🔑 Getting API Keys

Google Gemini (Recommended - Free):

1. Visit Google AI Studio
2. Sign in with Google account
3. Click "Get API key"
4. Copy the key (starts with AIza...)

OpenAI:

1. Visit OpenAI Platform
2. Create account and verify phone number
3. Generate API key
4. Copy the key (starts with sk-...)

🎯 How It Works

1. Click any [?] icon next to configuration fields
2. Loading modal appears with smooth animation
3. AI processes your request in real-time
4. Explanation appears in a beautiful modal popup
5. Learn about Magento configurations instantly!

🛠️ Technical Details

Requirements

• Magento 2.4.0 or higher
• PHP 8.1 or higher
• Valid AI provider API key

Architecture

• Clean MVC Structure - Follows Magento best practices
• Dependency Injection - Proper service layer implementation
• Interface-Based Design - Easy to extend with new AI providers
• Secure Configuration - Encrypted API key storage
• Comprehensive Logging - Full audit trail

File Structure

app/code/Minsar/AdminAssistant/
├── Api/                    # Service contracts
├── Controller/             # Admin controllers
├── Model/                  # Business logic
│   ├── Ai/                # AI client implementations
│   ├── Config/            # Configuration sources
│   └── Log/               # Logging services
├── etc/                   # Module configuration
└── view/adminhtml/        # Admin templates

🔍 Troubleshooting

Common Issues

No help icons appearing:

• Clear cache: php bin/magento cache:flush
• Check if module is enabled
• Refresh browser (Ctrl+F5)

API errors:

• Verify API key is correct
• Check logs: var/log/minsar_adminassistant.log
• Ensure API provider has credits/quota

Network errors:

• Check server internet connectivity
• Verify firewall allows outbound HTTPS

Debug Mode

Enable detailed logging in module configuration for troubleshooting.

🔒 Privacy & Security

What We Send

• Configuration field names and labels
• Field descriptions and comments
• No customer data or PII

What We Don't Send

• Customer information
• Order data
• Payment details
• Store credentials
• Admin user data

Security Features

• API keys stored encrypted
• Request rate limiting
• Comprehensive audit logging
• No automatic store changes

🤝 Contributing

We welcome contributions! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

Development Setup

git clone https://github.com/minsarai/magento2-ai-admin-assistant.git
cd magento2-ai-admin-assistant
# Follow installation steps above

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

• 📧 Email: saifali.openai@gmail.com
• 🐛 Issues: GitHub Issues
• 📖 Documentation: Wiki

🌟 Changelog

v1.0.0 (2026-01-22)

• ✨ Initial release
• 🤖 Google Gemini integration
• 🔧 OpenAI GPT-3.5 support
• 📱 Modal UI with loading states
• 🔒 Secure API key management
• 📊 Comprehensive logging

Made with ❤️ by minsarai

Transform your Magento admin experience with the power of AI!