|
| 1 | +# 🚀 FraudGuard Pro - Deployment Guide |
| 2 | + |
| 3 | +## Quick Setup for Anyone |
| 4 | + |
| 5 | +### 1. **Clone & Install** |
| 6 | +```bash |
| 7 | +git clone <your-repo-url> |
| 8 | +cd hackth |
| 9 | +pip install -r requirements.txt |
| 10 | +``` |
| 11 | + |
| 12 | +### 2. **Run the Application** |
| 13 | +```bash |
| 14 | +python modern_fraud_dashboard.py |
| 15 | +``` |
| 16 | + |
| 17 | +### 3. **Access Dashboard** |
| 18 | +- Open: `http://localhost:5000` |
| 19 | +- The system will show "API Configuration Required" |
| 20 | + |
| 21 | +### 4. **Add Your Google AI API Key** |
| 22 | +1. Click **"Configure Now"** or go to **Settings** |
| 23 | +2. Enter your Google AI API key |
| 24 | +3. Click **"Test API Key"** - system will find best model |
| 25 | +4. Save settings |
| 26 | + |
| 27 | +### 5. **Start Analyzing Fraud** 🎯 |
| 28 | +- Upload CSV files |
| 29 | +- Get AI-powered fraud analysis |
| 30 | +- View detailed risk assessments |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## 🔑 Getting Google AI API Key |
| 35 | + |
| 36 | +1. Go to [Google AI Studio](https://makersuite.google.com/app/apikey) |
| 37 | +2. Create new API key |
| 38 | +3. Copy the key (starts with `AIza...`) |
| 39 | +4. Add to FraudGuard Pro settings |
| 40 | + |
| 41 | +--- |
| 42 | + |
| 43 | +## 📊 CSV Format Support |
| 44 | + |
| 45 | +**UPI Transactions:** |
| 46 | +```csv |
| 47 | +transaction_id,user_id,amount,transaction_type,location,timestamp |
| 48 | +``` |
| 49 | + |
| 50 | +**Credit Card:** |
| 51 | +```csv |
| 52 | +transaction_id,user_id,amount,merchant,category,timestamp |
| 53 | +``` |
| 54 | + |
| 55 | +**Generic:** |
| 56 | +```csv |
| 57 | +transaction_id,amount,type,location,timestamp |
| 58 | +``` |
| 59 | + |
| 60 | +--- |
| 61 | + |
| 62 | +## ✨ Features |
| 63 | + |
| 64 | +- **🤖 AI-Powered Analysis** - Smart fraud detection with explanations |
| 65 | +- **📊 Professional Dashboard** - Clean, modern interface |
| 66 | +- **🌓 Dark/Light Theme** - User preference support |
| 67 | +- **📱 Responsive Design** - Works on all devices |
| 68 | +- **🔒 Secure** - No API keys stored in code |
| 69 | +- **⚡ Fast Processing** - Real-time analysis |
| 70 | + |
| 71 | +--- |
| 72 | + |
| 73 | +## 🛠️ No Setup Required |
| 74 | + |
| 75 | +- ❌ No database setup needed |
| 76 | +- ❌ No complex configuration |
| 77 | +- ❌ No API keys in code |
| 78 | +- ✅ Just run and add your API key! |
| 79 | + |
| 80 | +--- |
| 81 | + |
| 82 | +## 🔧 Troubleshooting |
| 83 | + |
| 84 | +**"API Configuration Required"** |
| 85 | +- Add your Google AI API key in Settings |
| 86 | +- Test the key to ensure it works |
| 87 | +- System will auto-select best model |
| 88 | + |
| 89 | +**CSV Upload Issues** |
| 90 | +- Ensure CSV has required columns |
| 91 | +- Check file format is valid CSV |
| 92 | +- File size limit: 50MB |
| 93 | + |
| 94 | +**AI Analysis Not Working** |
| 95 | +- Verify API key is valid |
| 96 | +- Check Google AI billing status |
| 97 | +- Test key in Settings page |
| 98 | + |
| 99 | +--- |
| 100 | + |
| 101 | +## 🌟 Ready to Deploy! |
| 102 | + |
| 103 | +Your FraudGuard Pro system is now completely self-contained and ready for deployment. Users just need to: |
| 104 | + |
| 105 | +1. **Run the application** |
| 106 | +2. **Add their API key** |
| 107 | +3. **Start detecting fraud!** |
| 108 | + |
| 109 | +No complex setup, no hardcoded credentials - just professional fraud detection! 🚀 |
0 commit comments