feat: Complete admin panel implementation
- Add user management system with all CRUD operations - Add promotion statistics dashboard with export - Simplify Trading & Market settings UI - Fix promotion schema (dates now optional) - Add missing API endpoints and PATCH support - Add comprehensive documentation - Fix critical bugs (deletePromotion, duplicate endpoints) All features tested and production-ready.
This commit is contained in:
299
docs/ADMIN_QUICK_START.md
Normal file
299
docs/ADMIN_QUICK_START.md
Normal file
@@ -0,0 +1,299 @@
|
||||
# Admin Panel Quick Start Guide
|
||||
|
||||
## 🚀 Quick Access
|
||||
|
||||
1. Log in with admin credentials (staffLevel >= 3)
|
||||
2. Navigate to Admin section
|
||||
3. Select the tab you need
|
||||
|
||||
---
|
||||
|
||||
## 📋 Quick Actions
|
||||
|
||||
### Maintenance Mode
|
||||
|
||||
**Enable Maintenance:**
|
||||
1. Go to **Maintenance** tab
|
||||
2. Toggle switch ON
|
||||
3. Enter custom message
|
||||
4. Save
|
||||
|
||||
**Allow Admin Access During Maintenance:**
|
||||
1. Add Steam IDs to whitelist
|
||||
2. Admins can login via maintenance page
|
||||
|
||||
---
|
||||
|
||||
### Create Announcement
|
||||
|
||||
**Steps:**
|
||||
1. **Announcements** tab → **+ Create**
|
||||
2. Choose type: Info | Warning | Success | Error
|
||||
3. Write message
|
||||
4. Toggle enabled
|
||||
5. (Optional) Set schedule dates
|
||||
6. Save
|
||||
|
||||
**Quick Types:**
|
||||
- 🔵 Info - General updates
|
||||
- 🟡 Warning - Important notices
|
||||
- 🟢 Success - Good news
|
||||
- 🔴 Error - Critical alerts
|
||||
|
||||
---
|
||||
|
||||
### Create Promotion
|
||||
|
||||
**Quick Setup:**
|
||||
1. **Promotions** tab → **+ Create**
|
||||
2. Fill basics:
|
||||
- Name & description
|
||||
- Type (deposit_bonus, discount, etc.)
|
||||
- Start/end dates
|
||||
3. Configure rewards:
|
||||
- Bonus percentage or amount
|
||||
- Min deposit (if applicable)
|
||||
- Max bonus cap
|
||||
4. Set limits:
|
||||
- Uses per user
|
||||
- Total uses
|
||||
5. Save
|
||||
|
||||
**View Stats:**
|
||||
- Click **Stats** button on any promotion
|
||||
- See usage, revenue, and user data
|
||||
- Export for reports
|
||||
|
||||
---
|
||||
|
||||
### User Management
|
||||
|
||||
**Search User:**
|
||||
1. **User Management** tab
|
||||
2. Type username, Steam ID, or email
|
||||
3. Results appear instantly
|
||||
|
||||
**Quick Actions:**
|
||||
- 👁️ **Details** - View full profile
|
||||
- 💰 **Balance** - Add/remove funds
|
||||
- 🚫 **Ban** - Temporarily or permanently ban
|
||||
- ⭐ **Promote** - Set staff level
|
||||
|
||||
**Adjust Balance:**
|
||||
1. Click **Balance** on user
|
||||
2. Select Credit (add) or Debit (subtract)
|
||||
3. Enter amount
|
||||
4. Provide reason (required for audit)
|
||||
5. Confirm
|
||||
|
||||
**Ban User:**
|
||||
1. Click **Ban**
|
||||
2. Enter reason (required)
|
||||
3. Set duration in hours (0 = permanent)
|
||||
4. Confirm
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Trading & Market Settings
|
||||
|
||||
### Trading Settings
|
||||
- **Enabled** - Toggle trading on/off
|
||||
- **Deposit/Withdraw** - Control each separately
|
||||
- **Min Amounts** - Set minimums for deposits/withdrawals
|
||||
- **Withdraw Fee** - Percentage fee (0-100%)
|
||||
- **Max Items** - Items per trade limit
|
||||
|
||||
### Market Settings
|
||||
- **Enabled** - Toggle marketplace
|
||||
- **Commission** - Platform fee (0-100%)
|
||||
- **Price Limits** - Min/max listing prices
|
||||
- **Auto-Update** - Automatic price updates
|
||||
- **Update Interval** - How often to update prices
|
||||
|
||||
**Don't forget to SAVE after changes!**
|
||||
|
||||
---
|
||||
|
||||
## 📊 Staff Levels
|
||||
|
||||
| Level | Role | Permissions |
|
||||
|-------|------|-------------|
|
||||
| 0 | User | Regular user access |
|
||||
| 1 | Moderator | Basic moderation |
|
||||
| 2 | Support | User support tools |
|
||||
| 3 | Admin | Full admin panel access |
|
||||
| 4 | Super Admin | All permissions |
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Common Mistakes to Avoid
|
||||
|
||||
1. ❌ Forgetting to enable announcements/promotions
|
||||
2. ❌ Not setting end dates for time-limited promotions
|
||||
3. ❌ Enabling maintenance without adding admin Steam IDs
|
||||
4. ❌ Forgetting to save changes
|
||||
5. ❌ Banning users without providing reason
|
||||
|
||||
---
|
||||
|
||||
## 🆘 Quick Troubleshooting
|
||||
|
||||
**Changes not saving?**
|
||||
- Check for error messages in console
|
||||
- Verify all required fields are filled
|
||||
- Ensure you have admin permissions
|
||||
|
||||
**Announcement not showing?**
|
||||
- Is it enabled?
|
||||
- Check start/end dates
|
||||
- Clear browser cache
|
||||
|
||||
**Can't access during maintenance?**
|
||||
- Add your Steam ID to whitelist
|
||||
- Use Steam login on maintenance page
|
||||
|
||||
**User balance not updating?**
|
||||
- Check transaction logs
|
||||
- Verify reason was provided
|
||||
- Ensure amount is valid
|
||||
|
||||
---
|
||||
|
||||
## 📈 Best Practices
|
||||
|
||||
### Announcements
|
||||
- ✅ Use appropriate type for message severity
|
||||
- ✅ Keep messages concise and clear
|
||||
- ✅ Set end dates for temporary announcements
|
||||
- ✅ Test dismissibility before going live
|
||||
|
||||
### Promotions
|
||||
- ✅ Set realistic usage limits
|
||||
- ✅ Always set end dates
|
||||
- ✅ Monitor stats regularly
|
||||
- ✅ Test promo codes before announcing
|
||||
- ✅ Use descriptive names
|
||||
|
||||
### User Management
|
||||
- ✅ Always provide detailed ban reasons
|
||||
- ✅ Document balance adjustments
|
||||
- ✅ Be cautious with permanent bans
|
||||
- ✅ Review user history before actions
|
||||
- ✅ Communicate with users about major actions
|
||||
|
||||
### Maintenance
|
||||
- ✅ Schedule during low-traffic hours
|
||||
- ✅ Announce in advance
|
||||
- ✅ Keep maintenance windows short
|
||||
- ✅ Test admin bypass before enabling
|
||||
- ✅ Provide estimated completion time
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Security Reminders
|
||||
|
||||
1. **Never share admin credentials**
|
||||
2. **Always provide reasons for actions** (audit trail)
|
||||
3. **Double-check before banning users**
|
||||
4. **Use strong passwords and 2FA**
|
||||
5. **Log out when finished**
|
||||
6. **Monitor admin activity logs**
|
||||
|
||||
---
|
||||
|
||||
## 📞 Emergency Actions
|
||||
|
||||
### Site Down / Critical Issue
|
||||
1. Enable maintenance mode immediately
|
||||
2. Set clear message explaining issue
|
||||
3. Add all admin Steam IDs to whitelist
|
||||
4. Investigate and fix
|
||||
5. Test thoroughly
|
||||
6. Disable maintenance
|
||||
|
||||
### Malicious User
|
||||
1. Ban immediately
|
||||
2. Document reason thoroughly
|
||||
3. Review recent transactions
|
||||
4. Check for associated accounts
|
||||
5. Report to security team
|
||||
|
||||
### Promotion Error
|
||||
1. Disable promotion immediately
|
||||
2. Review usage logs
|
||||
3. Adjust balances if necessary
|
||||
4. Document what happened
|
||||
5. Fix and re-enable or create new
|
||||
|
||||
---
|
||||
|
||||
## 💡 Pro Tips
|
||||
|
||||
1. **Use search efficiently** - Partial matches work for usernames
|
||||
2. **Export promotion data** - Use Stats modal export for reports
|
||||
3. **Schedule maintenance** - Use date/time pickers for planned windows
|
||||
4. **Monitor regularly** - Check user activity and promotion performance
|
||||
5. **Keep notes** - Document why you made certain decisions
|
||||
6. **Test first** - Try changes on test accounts when possible
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Daily Admin Tasks
|
||||
|
||||
### Morning Checklist
|
||||
- [ ] Check for new user issues
|
||||
- [ ] Review overnight transactions
|
||||
- [ ] Check active promotions performance
|
||||
- [ ] Verify no maintenance mode enabled
|
||||
- [ ] Review any ban appeals
|
||||
|
||||
### Weekly Tasks
|
||||
- [ ] Analyze promotion statistics
|
||||
- [ ] Review user growth
|
||||
- [ ] Check trading/market performance
|
||||
- [ ] Update announcements if needed
|
||||
- [ ] Clean up expired promotions
|
||||
|
||||
### Monthly Tasks
|
||||
- [ ] Full platform audit
|
||||
- [ ] Review all active staff members
|
||||
- [ ] Analyze revenue from promotions
|
||||
- [ ] Update trading/market settings if needed
|
||||
- [ ] Plan upcoming promotions
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Quick Links
|
||||
|
||||
- [Complete Documentation](./ADMIN_PANEL_COMPLETE.md)
|
||||
- [API Reference](./ADMIN_PANEL_COMPLETE.md#backend-api-endpoints)
|
||||
- [Troubleshooting Guide](./ADMIN_PANEL_COMPLETE.md#troubleshooting)
|
||||
|
||||
---
|
||||
|
||||
## 📱 Keyboard Shortcuts
|
||||
|
||||
*To be implemented in future version*
|
||||
|
||||
---
|
||||
|
||||
## 🆕 Recent Updates
|
||||
|
||||
**Version 1.0.0**
|
||||
- ✅ Full admin panel implementation
|
||||
- ✅ User management system
|
||||
- ✅ Promotion analytics
|
||||
- ✅ Enhanced security features
|
||||
|
||||
---
|
||||
|
||||
**Need More Help?**
|
||||
Refer to the [Complete Admin Panel Guide](./ADMIN_PANEL_COMPLETE.md) for detailed information.
|
||||
|
||||
**Questions?**
|
||||
Contact the development team or check the troubleshooting section.
|
||||
|
||||
---
|
||||
|
||||
*Last Updated: 2024*
|
||||
*Happy Administrating! 🎉*
|
||||
Reference in New Issue
Block a user