How abhinavhh/smart_irrigation works
Project type and purpose
• Frontend: React + Vite single-page application for real-time dashboards, charts, and user workflows.
• Backend (described in README): Spring Boot monolith providing REST and WebSocket APIs, persisting to PostgreSQL, caching in Redis, scheduling irrigation, handling authentication, email, and ML recommendations.
• Edge/IoT: ESP32/Arduino microcontrollers collect sensor data (BLE/Wi-Fi) and forward via MQTT to the backend.
File structure (frontend portion)
• Top level:
• index.html, package.json / package-lock.json, Vite and PostCSS configs, Tailwind config, eslint.config.js, .env, vercel.json → build & deployment controls.
• public/ → static assets and redirect rules.
• src/ → React app:
• main.jsx & index.css → app bootstrap for Vite.
• App.jsx / App.css → core layout.
• Components/ → UI widgets & pages: graphs, forms, panels, navbars, notifications, authentication flows.
• api/axios.jsx → centralized HTTP client.
• assets/database.sql → sample DB scripts (for backend).
README for additional insights
IoT Sensors → Microcontroller → Spring Boot API → {PostgreSQL, Redis, WebSockets → React Frontend, SMTP, Scheduler}
• Technology stack tables detail frameworks, libraries, and infrastructure choices.
a. Main components
1. IoT Layer: Sensors (temperature, humidity, soil moisture) + Microcontroller (ESP32/Arduino)
2. API Layer: Spring Boot application
3. Data Stores: PostgreSQL, Redis Cache
4. Real-time Channels: MQTT (sensor → backend), STOMP/WebSocket (backend → frontend)
5. Frontend: React SPA (Vite bundler, Tailwind, Chart.js / D3.js visuals, React Router)
6. External Services: SMTP mail server, Scheduler service, Prometheus/Grafana, ELK logging
b. Relationships & interactions
• Sensors → Microcontroller (BLE/Wi-Fi)
• Microcontroller → Spring Boot (MQTT over TLS)
• Spring Boot → PostgreSQL (JDBC)
• Spring Boot ↔ Redis (cache for thresholds, session data)
• Spring Boot → Frontend (WebSocket/STOMP + REST endpoints via Axios)
• Frontend → User’s browser (UI interaction)
• Spring Boot → SMTP (JavaMail) for OTP & notifications
• Spring Boot → Scheduler (internal job scheduling)
• Monitoring stack hooks into Spring Boot (Prometheus exporters, ELK ingest)
c. Architectural patterns & design principles
• Monolithic service with layered architecture: controller, service, repository (Spring Data JPA).
• Publish/subscribe for real-time updates (WebSocket + STOMP).
• CQRS-like separation: REST for commands/queries; WebSockets for push.
• Context API in React for global state.
• Configuration-as-code (.env files, Vite, Tailwind) and containerization readiness (Docker Compose).
d. Key technologies / libraries
• Frontend: React 18, Vite, Tailwind CSS, Chart.js, D3.js, Material-UI, React Router, React Hook Form, Axios
• Backend: Spring Boot 3.1, Spring Security + JWT, Spring Data JPA (PostgreSQL), STOMP+WebSocket, JavaMail, JUnit/Mockito
• Infra: Docker, Docker Compose, GitHub Actions, Prometheus, Grafana, ELK