docs: update documentation for v0.4.0 release

- Update README.md with v0.4.0 features and screenshots placeholders
- Update architecture.md with v0.4.0 implementation status
- Update progress.md marking all 27 tasks as completed
- Create CHANGELOG.md with complete release notes
- Add v0.4.0 frontend components and hooks
This commit is contained in:
Luca Sacchi Ricciardi
2026-04-07 18:07:23 +02:00
parent e19ef64085
commit d222d21618
21 changed files with 1024 additions and 313 deletions

View File

@@ -1,7 +1,7 @@
# mockupAWS - Backend Profiler & Cost Estimator
> **Versione:** 0.3.0 (Completata)
> **Stato:** Database, Backend & Frontend Implementation Complete
> **Versione:** 0.4.0 (Completata)
> **Stato:** Release Candidate
## Panoramica
@@ -34,10 +34,14 @@ A differenza dei semplici calcolatori di costo online, mockupAWS permette di:
### 📊 Interfaccia Web
- Dashboard responsive con grafici in tempo reale
- Dark/Light mode
- Form guidato per creazione scenari
- Vista dettaglio con metriche, costi, logs e PII detection
- Export report PDF/CSV
### 📈 Data Visualization & Reports (v0.4.0)
- **Report Generation**: PDF/CSV professionali con template personalizzabili
- **Data Visualization**: Grafici interattivi con Recharts (Pie, Area, Bar)
- **Scenario Comparison**: Confronto side-by-side di 2-4 scenari con delta costi
- **Dark/Light Mode**: Toggle tema con rilevamento preferenza sistema
### 🔒 Sicurezza
- Rilevamento automatico email (PII) nei log
@@ -75,6 +79,30 @@ A differenza dei semplici calcolatori di costo online, mockupAWS permette di:
└────────────────────────────────────────────────────────────────────┘
```
## Screenshots
> **Nota:** Gli screenshot saranno aggiunti nella release finale.
### Dashboard
![Dashboard](docs/screenshots/dashboard.png)
*Dashboard principale con lista scenari e metriche overview*
### Scenario Detail con Grafici
![Scenario Detail](docs/screenshots/scenario-detail.png)
*Vista dettaglio scenario con cost breakdown chart e time series*
### Scenario Comparison
![Comparison](docs/screenshots/comparison.png)
*Confronto side-by-side di multipli scenari con indicatori delta*
### Dark Mode
![Dark Mode](docs/screenshots/dark-mode.png)
*Tema scuro applicato a tutta l'interfaccia*
### Report Generation
![Reports](docs/screenshots/reports.png)
*Generazione e download report PDF/CSV*
## Stack Tecnologico
### Backend
@@ -292,24 +320,33 @@ mockupAWS/
│ └── services/ # Business logic
│ ├── pii_detector.py
│ ├── cost_calculator.py
── ingest_service.py
── ingest_service.py
│ └── report_service.py # PDF/CSV generation (v0.4.0)
├── frontend/ # Frontend React
│ ├── src/
│ │ ├── App.tsx # Root component
│ │ ├── components/
│ │ │ ├── layout/ # Header, Sidebar, Layout
│ │ │ ── ui/ # shadcn components
│ │ │ ── ui/ # shadcn components
│ │ │ ├── charts/ # Recharts components (v0.4.0)
│ │ │ ├── comparison/ # Comparison components (v0.4.0)
│ │ │ └── reports/ # Report generation UI (v0.4.0)
│ │ ├── hooks/ # React Query hooks
│ │ ├── lib/
│ │ │ ├── api.ts # Axios client
│ │ │ ── utils.ts # Utility functions
│ │ │ ── utils.ts # Utility functions
│ │ │ └── theme-provider.tsx # Dark mode (v0.4.0)
│ │ ├── pages/ # Page components
│ │ │ ├── Dashboard.tsx
│ │ │ ├── ScenarioDetail.tsx
│ │ │ ── ScenarioEdit.tsx
│ │ │ ── ScenarioEdit.tsx
│ │ │ ├── Compare.tsx # Scenario comparison (v0.4.0)
│ │ │ └── Reports.tsx # Reports page (v0.4.0)
│ │ └── types/
│ │ └── api.ts # TypeScript types
│ ├── e2e/ # E2E tests (v0.4.0)
│ ├── package.json
│ ├── playwright.config.ts # Playwright config (v0.4.0)
│ └── vite.config.ts
├── alembic/ # Database migrations
│ └── versions/ # Migration files
@@ -393,17 +430,24 @@ npm run build
- [x] Integrazione API con Axios + React Query
- [x] Componenti UI shadcn/ui
### v0.4.0 (Prossima Release)
- [ ] Generazione report PDF/CSV
- [ ] Confronto scenari
- [ ] Grafici interattivi con Recharts
- [ ] Dark/Light mode toggle
### v0.4.0 ✅ Completata (2026-04-07)
- [x] Generazione report PDF/CSV con ReportLab
- [x] Confronto scenari (2-4 scenari side-by-side)
- [x] Grafici interattivi con Recharts (Pie, Area, Bar)
- [x] Dark/Light mode toggle con rilevamento sistema
- [x] E2E Testing suite con 100 test cases (Playwright)
### v1.0.0
### v0.5.0 🔄 Pianificata
- [ ] Autenticazione JWT e autorizzazione
- [ ] API Keys management
- [ ] User preferences (tema, notifiche)
- [ ] Export dati avanzato (JSON, Excel)
### v1.0.0 ⏳ Future
- [ ] Backup automatico database
- [ ] Documentazione API completa (OpenAPI)
- [ ] Performance optimizations
- [ ] Production deployment guide
- [ ] Testing E2E
## Contributi