|
| 1 | +# 🔑 GitHub Secret Setup Guide |
| 2 | + |
| 3 | +## ✅ Code Successfully Pushed! |
| 4 | + |
| 5 | +Your dashboard is now at: **https://github.com/kaledh4/Intelligence_Platform** |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## 🔐 IMPORTANT: Add Your OpenRouter API Key |
| 10 | + |
| 11 | +### Secret Key Name (EXACT): |
| 12 | +``` |
| 13 | +OPENROUTER_API_KEY |
| 14 | +``` |
| 15 | + |
| 16 | +### Step-by-Step Instructions: |
| 17 | + |
| 18 | +#### 1️⃣ Get Your OpenRouter API Key |
| 19 | +1. Go to: **https://openrouter.ai/** |
| 20 | +2. Sign up or login |
| 21 | +3. Visit: **https://openrouter.ai/keys** |
| 22 | +4. Click "Create Key" |
| 23 | +5. Copy the API key (starts with `sk-or-...`) |
| 24 | + |
| 25 | +#### 2️⃣ Add Secret to GitHub |
| 26 | +1. Go to: **https://github.com/kaledh4/Intelligence_Platform/settings/secrets/actions** |
| 27 | + |
| 28 | + Or manually navigate: |
| 29 | + - Go to your repo: https://github.com/kaledh4/Intelligence_Platform |
| 30 | + - Click **Settings** (top menu) |
| 31 | + - Click **Secrets and variables** (left sidebar) |
| 32 | + - Click **Actions** |
| 33 | + |
| 34 | +2. Click **"New repository secret"** (green button) |
| 35 | + |
| 36 | +3. Fill in: |
| 37 | + - **Name**: `OPENROUTER_API_KEY` (exactly as shown, all caps) |
| 38 | + - **Secret**: Paste your OpenRouter API key |
| 39 | + |
| 40 | +4. Click **"Add secret"** |
| 41 | + |
| 42 | +--- |
| 43 | + |
| 44 | +## 🌐 Enable GitHub Pages |
| 45 | + |
| 46 | +### Quick Link: |
| 47 | +**https://github.com/kaledh4/Intelligence_Platform/settings/pages** |
| 48 | + |
| 49 | +### Steps: |
| 50 | +1. Go to **Settings** → **Pages** |
| 51 | +2. Under **"Build and deployment"**: |
| 52 | + - **Source**: Select **"GitHub Actions"** |
| 53 | +3. Click **Save** |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +## 🚀 Deploy Your Dashboard |
| 58 | + |
| 59 | +### Option 1: Automatic (Recommended) |
| 60 | +The workflow will run automatically: |
| 61 | +- **Daily at 6 AM UTC** |
| 62 | +- **On every push to main** |
| 63 | + |
| 64 | +### Option 2: Manual (Deploy Now) |
| 65 | +1. Go to: **https://github.com/kaledh4/Intelligence_Platform/actions** |
| 66 | +2. Click on **"Daily AI Updates & Deploy to GitHub Pages"** |
| 67 | +3. Click **"Run workflow"** (dropdown button) |
| 68 | +4. Click **"Run workflow"** (green button) |
| 69 | +5. Wait 2-3 minutes |
| 70 | +6. Your site will be live! |
| 71 | + |
| 72 | +--- |
| 73 | + |
| 74 | +## 🌍 Your Live URL |
| 75 | + |
| 76 | +After deployment completes: |
| 77 | +``` |
| 78 | +https://kaledh4.github.io/Intelligence_Platform/ |
| 79 | +``` |
| 80 | + |
| 81 | +--- |
| 82 | + |
| 83 | +## ✅ Quick Checklist |
| 84 | + |
| 85 | +- [ ] OpenRouter API key obtained from https://openrouter.ai/keys |
| 86 | +- [ ] Secret added to GitHub with name: `OPENROUTER_API_KEY` |
| 87 | +- [ ] GitHub Pages enabled (source: GitHub Actions) |
| 88 | +- [ ] Workflow triggered (manually or wait for auto-run) |
| 89 | +- [ ] Site accessible at: https://kaledh4.github.io/Intelligence_Platform/ |
| 90 | + |
| 91 | +--- |
| 92 | + |
| 93 | +## 🔍 Verify Setup |
| 94 | + |
| 95 | +### Check Secret Is Set: |
| 96 | +1. Go to: https://github.com/kaledh4/Intelligence_Platform/settings/secrets/actions |
| 97 | +2. You should see `OPENROUTER_API_KEY` listed (value hidden for security) |
| 98 | + |
| 99 | +### Check Workflow Status: |
| 100 | +1. Go to: https://github.com/kaledh4/Intelligence_Platform/actions |
| 101 | +2. Latest workflow run should show green checkmark ✅ |
| 102 | +3. Click on it to see detailed logs |
| 103 | + |
| 104 | +### Check Site Is Live: |
| 105 | +1. Visit: https://kaledh4.github.io/Intelligence_Platform/ |
| 106 | +2. Dashboard should load with AI-generated content |
| 107 | +3. Install prompt should appear after 5 seconds |
| 108 | + |
| 109 | +--- |
| 110 | + |
| 111 | +## 🆘 Troubleshooting |
| 112 | + |
| 113 | +### Workflow Fails? |
| 114 | +- **Check**: Secret name is exactly `OPENROUTER_API_KEY` (case-sensitive) |
| 115 | +- **Check**: API key is valid and has credits |
| 116 | +- **View**: Logs in Actions tab for detailed error |
| 117 | + |
| 118 | +### Site Not Loading? |
| 119 | +- **Wait**: 2-3 minutes after first deployment |
| 120 | +- **Check**: GitHub Pages is enabled in Settings → Pages |
| 121 | +- **Verify**: Workflow completed successfully (green checkmark) |
| 122 | + |
| 123 | +### API Not Working? |
| 124 | +- **Verify**: OpenRouter account has available credits |
| 125 | +- **Check**: Browser console for errors (F12) |
| 126 | +- **Test**: Manually refresh the dashboard |
| 127 | + |
| 128 | +--- |
| 129 | + |
| 130 | +## 📊 Monitor Your Dashboard |
| 131 | + |
| 132 | +### Daily Updates |
| 133 | +- Automatic updates at **6 AM UTC** daily |
| 134 | +- Check https://github.com/kaledh4/Intelligence_Platform/actions |
| 135 | +- View logs for each automated run |
| 136 | + |
| 137 | +### Usage |
| 138 | +- OpenRouter dashboard: https://openrouter.ai/activity |
| 139 | +- GitHub Actions usage: https://github.com/kaledh4/Intelligence_Platform/actions |
| 140 | + |
| 141 | +--- |
| 142 | + |
| 143 | +## 🎉 That's It! |
| 144 | + |
| 145 | +1. Add the secret: `OPENROUTER_API_KEY` |
| 146 | +2. Enable GitHub Pages |
| 147 | +3. Run the workflow |
| 148 | +4. Enjoy your AI-powered dashboard! |
| 149 | + |
| 150 | +**Your dashboard will be live at:** |
| 151 | +### 🌐 https://kaledh4.github.io/Intelligence_Platform/ |
| 152 | + |
| 153 | +--- |
| 154 | + |
| 155 | +## 📞 Quick Links |
| 156 | + |
| 157 | +- **Repository**: https://github.com/kaledh4/Intelligence_Platform |
| 158 | +- **Settings**: https://github.com/kaledh4/Intelligence_Platform/settings |
| 159 | +- **Secrets**: https://github.com/kaledh4/Intelligence_Platform/settings/secrets/actions |
| 160 | +- **Pages**: https://github.com/kaledh4/Intelligence_Platform/settings/pages |
| 161 | +- **Actions**: https://github.com/kaledh4/Intelligence_Platform/actions |
| 162 | +- **OpenRouter**: https://openrouter.ai/keys |
0 commit comments