diff --git a/README.md b/README.md index 99598bb19..3ec87b915 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # TCKRTUIYO - Rainfall Station RTU Web Interface +> **Current Version**: v1 (Flask) - See `src/` +> **Next Version**: v2 (React) - See `v2/` (in development) + A modern web-based interface for a Base Station/Real-Time Unit (RTU) rainfall monitoring system, designed for a 7" capacitive touchscreen display (1024x600). The system monitors and logs rainfall and related sensors, transmits data to a server, and provides both a kiosk-mode local display and a full HD remote interface. ## Features @@ -25,10 +28,16 @@ A modern web-based interface for a Base Station/Real-Time Unit (RTU) rainfall mo ## Tech Stack +### v1 (Active - Flask) - **Backend**: Flask + Flask-SocketIO - **Frontend**: Bootstrap 5.3, Socket.IO Client - **Python**: 3.x +### v2 (In Development - React) +- **Frontend**: React 18 + TypeScript + TailwindCSS +- **Build**: Vite +- **UI Components**: shadcn/ui + ## Getting Started ### Prerequisites @@ -87,22 +96,39 @@ FLASK_DEBUG=1 python src/app.py | `/api/files/` | DELETE | Delete file | | `/api/files/export` | POST | Generate tidEDA format | +## Version History + +| Version | Description | Date | +|---------|-------------|------| +| v1 | Original Flask + Bootstrap interface (archived in `src_v1/`) | Pre-2026 | +| v2 | React/Next.js interface (in development in `v2/`) | 2026-03 | + ## Project Structure ``` . -├── src/ -│ ├── app.py # Flask application +├── src/ # Currently active Flask v1 application +├── src_v1/ # Archived Flask v1 application (backup) +│ ├── app.py # Flask application │ ├── templates/ # HTML templates │ │ ├── dashboard.html # Main kiosk dashboard │ │ ├── settings.html # Configuration UI │ │ ├── calibration.html # Sensor calibration │ │ └── files.html # File management -│ └── data/ -│ └── logger/ # CSV storage (/myvscada/logger) -├── requirements.txt # Python dependencies -├── README.md # This file -└── .planning/ # GSD planning artifacts +│ ├── static/ # CSS, JS, images +│ ├── data/ # CSV storage +│ ├── routes/ # Route handlers +│ ├── services/ # Business logic +│ └── requirements.txt # Python dependencies +├── v2/ # NEW: React v2 interface (development) +│ ├── src/app/ # React application +│ ├── guidelines/ # Design system +│ ├── package.json # Node dependencies +│ └── vite.config.ts # Vite config +├── sample_interface/ # Reference implementation template +├── requirements.txt # Current Python dependencies +├── README.md # This file +└── .planning/ # GSD planning artifacts ``` ## Kiosk Mode Setup