docs: Add project documentation
- README.md: Quick start, API endpoints, ports - PROJECT.md: Architecture, components, data models - ROADMAP.md: Version milestones (v0.1.x - v1.0.0) - TASKS.md: Current sprint tasks - TODO.md: Backlog items - docs/INSTALL.md: Setup and deployment - docs/USAGE.md: API examples - docs/CHEATSHEET.md: Quick reference
This commit is contained in:
46
TASKS.md
Normal file
46
TASKS.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# ESP32-Web Tasks
|
||||
|
||||
**Last Updated:** 2026-02-05
|
||||
|
||||
## Current Sprint: v0.2.0 — OSINT Features
|
||||
|
||||
### P1 - High
|
||||
- [ ] Download and parse IEEE OUI database
|
||||
- [ ] MAC vendor lookup utility
|
||||
- [ ] BLE company_id mapping
|
||||
- [ ] `GET /api/v1/devices/<mac>/profile` enriched endpoint
|
||||
|
||||
### P2 - Normal
|
||||
- [ ] Export endpoints (`/api/v1/export/devices.csv`)
|
||||
- [ ] Add vendor field population on device creation
|
||||
- [ ] Sensor heartbeat timeout detection
|
||||
|
||||
### P3 - Low
|
||||
- [ ] Add pagination to all list endpoints
|
||||
- [ ] Add OpenAPI/Swagger spec
|
||||
- [ ] Add request logging middleware
|
||||
|
||||
## Completed: v0.1.1 - Server Management
|
||||
|
||||
- [x] Makefile start/stop/restart/status commands
|
||||
- [x] Health endpoint with uptime tracking
|
||||
- [x] CLI module (esp32-web command)
|
||||
- [x] Initial database migration
|
||||
- [x] Listen on all interfaces (0.0.0.0:5500)
|
||||
|
||||
## Completed: v0.1.0 - Project Scaffold
|
||||
|
||||
- [x] Flask app factory pattern
|
||||
- [x] SQLAlchemy 2.x models
|
||||
- [x] API blueprint with endpoints
|
||||
- [x] UDP collector with parsers
|
||||
- [x] pytest fixtures and tests
|
||||
- [x] Containerfile for podman
|
||||
- [x] Makefile for common tasks
|
||||
|
||||
## Notes
|
||||
|
||||
- Sensors send data to UDP 5500
|
||||
- API listens on TCP 5500
|
||||
- Commands sent to sensors on UDP 5501
|
||||
- SQLite for dev, PostgreSQL for prod
|
||||
Reference in New Issue
Block a user