Skip to content

Latest commit

 

History

History
102 lines (70 loc) · 3.47 KB

File metadata and controls

102 lines (70 loc) · 3.47 KB

📚 HazeBot Admin Documentation

Welcome to the comprehensive documentation for HazeBot Admin - a modern, cross-platform Flutter admin panel for HazeBot.

📖 Documentation Index

🚀 Getting Started

Document Description
Setup Checklist Quick setup verification guide
APK Download Android APK installation instructions
Firebase Setup Push notification configuration

💻 Development

Document Description
Development Guide Development workflows, patterns, and best practices
Building Guide Build instructions for Web, Android, iOS, and Desktop

🚢 Deployment

Document Description
GitHub Actions CI/CD pipeline documentation
GitHub Secrets Repository secrets configuration

📋 Reference

Document Description
Features Complete feature documentation
Changelog Version history and release notes

🎯 Quick Navigation by Use Case

I want to...

Set up the app for the first time

  1. Start with Setup Checklist for prerequisites
  2. Follow the Main README for installation
  3. Configure Firebase Setup for push notifications

Install the Android app

Develop new features

  1. Read Development Guide for workflows and patterns
  2. Check Features to understand existing features
  3. Review Building Guide for platform-specific builds

Build for production

  1. Follow Building Guide for your target platform
  2. Configure GitHub Actions for automated builds
  3. Set up GitHub Secrets for CI/CD

Understand what the app can do


🔗 Related Documentation


📱 Platform Support

Platform Status Notes
Web ✅ Primary Best experience, recommended for desktop
Android ✅ Supported APK releases available
iOS ⚠️ Untested Should work, needs signing
Linux ✅ Supported Desktop build available
Windows ⚠️ Untested Should work with Flutter 3.0+
macOS ⚠️ Untested Should work, needs signing

🆘 Getting Help

  1. Check Documentation - Search this documentation first
  2. GitHub Issues - Open an issue
  3. HazeBot Backend - Some issues may be API-related, check HazeBot docs

🤝 Contributing

See the main README for contribution guidelines.


Made with 💖 for The Chillventory 📱✨