🌱 Modern React-based dashboard for managing grow rooms through Home Assistant.
- 🌡️ Real-time Monitoring: Temperature, humidity, VPD, CO2, and more
- 🎛️ Device Control: Lights, fans, pumps, and climate devices
- 📊 Data Visualization: Interactive charts and historical data
- 📝 Grow Logs: Real-time event logging with room-based filtering
- 🔒 Secure Authentication: JWT-based premium features
- 🎨 Modern UI: Dark theme with color-coded rooms
- 📱 Responsive Design: Works on desktop, tablet, and mobile
- Install via HACS (Home Assistant Community Store)
- Search for "OpenGrowBox"
- Click "Download" and follow setup wizard
- Access dashboard through Home Assistant sidebar
For detailed user documentation, see docs/USER.md.
# Clone repository
git clone <repository-url>
cd ogb-ha-gui
# Install dependencies
npm install
# Start development server
npm run dev
# Open browser to http://localhost:3004For developer documentation, see docs/DEVELOPER.md.
Comprehensive documentation is available in the docs/ directory:
| Document | Description |
|---|---|
| README | Documentation overview and table of contents |
| USER.md | Complete user guide for using the application |
| DEVELOPER.md | Developer guide for contributing and extending |
| ARCHITECTURE.md | System architecture and design patterns |
| API.md | WebSocket events and API reference |
| DEPLOYMENT.md | Production deployment instructions |
- Frontend: React 18, Vite, styled-components
- Communication: WebSocket to Home Assistant
- State Management: React Context API
- Routing: React Router
- Icons: React Icons (FontAwesome, etc.)
ogb-ha-gui/
├── src/
│ ├── Components/ # React components
│ ├── Pages/ # Route pages
│ ├── hooks/ # Custom hooks
│ ├── utils/ # Utility functions
│ ├── App.jsx # Main app
│ └── main.jsx # Entry point
├── docs/ # Documentation
├── public/ # Static assets
├── package.json # Dependencies
└── vite.config.ts # Build config
# Start development server
npm run dev
# Run type checking
npm run typecheck
# Run linter
npm run lint
# Build for production
npm run build
# Preview production build
npm run previewWe welcome contributions! Please read our contributing guidelines before submitting pull requests.
See bugs.md for known bugs and their status.
This project is licensed under the MIT License.
- 🐛 Report Bugs: Check existing issues or create a new one
- 💬 Community: Join our community forum
- 📖 Documentation: See docs/ for detailed guides
Happy Growing! 🌱
