Add admin panel quick start guide
This commit is contained in:
parent
5f8bac9ec4
commit
6021b94dbf
1 changed files with 128 additions and 0 deletions
128
ADMIN_QUICKSTART.md
Normal file
128
ADMIN_QUICKSTART.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
# Admin Panel - Quick Start
|
||||
|
||||
## 🎛 Access Admin Panel
|
||||
|
||||
**MAMP:** http://localhost:8888/admin.html
|
||||
|
||||
**Standard:** http://localhost:8000/admin.html
|
||||
|
||||
Or click **"Admin Panel →"** link in the main app footer.
|
||||
|
||||
---
|
||||
|
||||
## 📊 What You Can Do
|
||||
|
||||
### View Metrics
|
||||
- Total platforms configured
|
||||
- Total format configurations
|
||||
- Number of codecs in use
|
||||
- Aspect ratios supported
|
||||
|
||||
### Manage Platforms
|
||||
- **Add** new platforms (TikTok, Meta, YouTube, etc.)
|
||||
- **Edit** existing platform specifications
|
||||
- **Delete** platforms you no longer need
|
||||
- **Export** all specs to JSON (backup)
|
||||
- **Import** specs from JSON (restore/bulk update)
|
||||
|
||||
---
|
||||
|
||||
## ➕ Add New Platform (Quick)
|
||||
|
||||
1. Click **"+ Add New Platform"**
|
||||
2. Fill in:
|
||||
- **Platform Key:** `my_platform` (lowercase, no spaces)
|
||||
- **Platform Name:** `My Platform`
|
||||
- **Codec:** Select H264, H265, or VP9
|
||||
- **Container:** Select MP4, WebM, or MOV
|
||||
3. Add at least one format:
|
||||
- **Aspect Ratio:** `16:9`
|
||||
- **Resolution:** `1920x1080`
|
||||
- **Bitrate:** `1500k`
|
||||
- **Min Bitrate:** `1300k`
|
||||
- **Max Bitrate:** `1700k`
|
||||
- **Audio:** `128k`
|
||||
4. Click **"Save Platform"**
|
||||
|
||||
✅ Platform is now available in main app!
|
||||
|
||||
---
|
||||
|
||||
## 📝 Example Platforms
|
||||
|
||||
### TikTok Configuration
|
||||
|
||||
```
|
||||
Key: tiktok
|
||||
Name: TikTok
|
||||
Codec: libx265 (H265)
|
||||
Container: mp4
|
||||
|
||||
Formats:
|
||||
- 9:16 → 540x960 → 1050k (840-1300k) → Audio: 128k
|
||||
- 1:1 → 640x640 → 1000k (840-1200k) → Audio: 128k
|
||||
```
|
||||
|
||||
### Meta Configuration
|
||||
|
||||
```
|
||||
Key: meta
|
||||
Name: Meta (Facebook/Instagram)
|
||||
Codec: libx264 (H264)
|
||||
Container: mp4
|
||||
|
||||
Formats:
|
||||
- 1:1 → 720x720 → 1000k (840-1200k) → Audio: 128k
|
||||
- 16:9 → 1280x720 → 1250k (1100-1400k) → Audio: 128k
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💾 Backup & Restore
|
||||
|
||||
### Create Backup
|
||||
1. Click **"Export Specs (JSON)"**
|
||||
2. File downloads: `platform_specs_2025-10-16.json`
|
||||
3. Save somewhere safe
|
||||
|
||||
### Restore Backup
|
||||
1. Click **"Import Specs (JSON)"**
|
||||
2. Select your backup JSON file
|
||||
3. Confirms: "Specifications imported successfully"
|
||||
4. All platforms restored!
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Interface
|
||||
|
||||
**Black + Yellow Theme** - Matches main app
|
||||
|
||||
**Components:**
|
||||
- Metrics cards (yellow numbers)
|
||||
- Platform cards (expandable details)
|
||||
- Format tables (all aspect ratios)
|
||||
- Modal form (add/edit platforms)
|
||||
- Action buttons (yellow primary, outlined secondary)
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Important Notes
|
||||
|
||||
1. **Changes are immediate** - Saved platforms appear instantly in main app
|
||||
2. **No authentication** - Admin page is open (add auth for production)
|
||||
3. **Platform keys immutable** - Can't change key after creation (delete and recreate instead)
|
||||
4. **Backup before import** - Import replaces ALL existing platforms
|
||||
5. **Specs persist** - Saved to `backend/platform_specs.json` (auto-loads on restart)
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Quick Links
|
||||
|
||||
- **Main App:** index.html
|
||||
- **Admin Panel:** admin.html
|
||||
- **Full Admin Guide:** ADMIN_GUIDE.md
|
||||
- **API Docs:** README.md
|
||||
|
||||
---
|
||||
|
||||
**Ready to manage your platforms!** 🎉
|
||||
Loading…
Add table
Reference in a new issue