Initial commit
This commit is contained in:
renato97
206
DASHBOARD_INSTRUCTIONS.md
Normal file
206
DASHBOARD_INSTRUCTIONS.md
Normal file
@@ -0,0 +1,206 @@
|
||||
# 🎛️ Dashboard Integrado - Instrucciones de Uso
|
||||
|
||||
## 🚀 Inicio Rápido
|
||||
|
||||
### Ejecutar servicio completo con dashboard
|
||||
|
||||
```bash
|
||||
python3 main.py
|
||||
```
|
||||
|
||||
**¡Listo!** Tendrás:
|
||||
- ✅ Servicio principal procesando archivos automáticamente
|
||||
- ✅ Dashboard web accesible en **http://localhost:5000**
|
||||
|
||||
---
|
||||
|
||||
## 📊 ¿Qué es el Dashboard?
|
||||
|
||||
El dashboard es una **interfaz web moderna** que te permite:
|
||||
|
||||
### 🔍 Monitoreo
|
||||
- Ver todos los archivos de audio en tiempo real
|
||||
- Filtrar por origen (Local/WebDAV)
|
||||
- Buscar archivos por nombre
|
||||
- Ver estadísticas: total, procesados, pendientes
|
||||
|
||||
### ⚡ Control
|
||||
- **Reprocesar archivos** con un solo click
|
||||
- **Resetear archivos** para forzar reprocesamiento
|
||||
- **Descargar resultados** en múltiples formatos
|
||||
|
||||
### 📁 Gestión de Archivos
|
||||
Ver formatos disponibles para cada archivo:
|
||||
- 📝 TXT (transcripción)
|
||||
- 📋 MD (Markdown)
|
||||
- 📄 DOCX (documento editable)
|
||||
- 📑 PDF (documento PDF)
|
||||
|
||||
---
|
||||
|
||||
## 🌐 Uso del Dashboard
|
||||
|
||||
### 1. Acceder
|
||||
Abre tu navegador en: **http://localhost:5000**
|
||||
|
||||
### 2. Ver Archivos
|
||||
La página principal muestra:
|
||||
- **Header**: Título del dashboard
|
||||
- **Estadísticas**: Cards con total, procesados, pendientes
|
||||
- **Controles**: Botones para refrescar y reprocesar
|
||||
- **Lista**: Grid de archivos con información
|
||||
|
||||
### 3. Filtrar
|
||||
Usa los filtros en la parte superior:
|
||||
- ☑️ **Local**: Mostrar archivos de la carpeta downloads
|
||||
- ☑️ **WebDAV**: Mostrar archivos de Nextcloud
|
||||
- 🔍 **Búsqueda**: Escribir para filtrar por nombre
|
||||
|
||||
### 4. Acciones por Archivo
|
||||
|
||||
#### Para archivos **Pendientes**:
|
||||
1. Click en botón **🚀 Procesar**
|
||||
2. Confirmar si hay archivos existentes
|
||||
3. El archivo se encola para procesamiento
|
||||
4. El estado se actualiza automáticamente
|
||||
|
||||
#### Para archivos **Procesados**:
|
||||
1. Click en botón **🔄 Resetear**
|
||||
2. Confirmar la acción
|
||||
3. El archivo se marca como no procesado
|
||||
4. Podrás reprocesarlo cuando quieras
|
||||
|
||||
### 5. Descargar Resultados
|
||||
Si un archivo tiene formatos disponibles, verás enlaces:
|
||||
- 📝 TXT, 📋 MD, 📄 DOCX, 📑 PDF
|
||||
- Click directo para descargar
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Comandos Alternativos
|
||||
|
||||
### Solo Dashboard (sin servicio principal)
|
||||
```bash
|
||||
python3 main.py dashboard-only
|
||||
```
|
||||
|
||||
### Otros comandos disponibles
|
||||
```bash
|
||||
# Servicio completo
|
||||
python3 main.py
|
||||
|
||||
# Procesar audio individual
|
||||
python3 main.py whisper audio.mp3 salida.txt
|
||||
|
||||
# Procesar PDF individual
|
||||
python3 main.py pdf documento.pdf editable.docx
|
||||
|
||||
# Convertir texto a resumen
|
||||
python3 main.py txt2docx texto.txt resumen.docx
|
||||
|
||||
# Generar quiz
|
||||
python3 main.py quiz "texto del quiz" quiz.docx
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📱 Interfaz Responsive
|
||||
|
||||
El dashboard funciona en:
|
||||
- 💻 **Desktop**: Interfaz completa con todas las funciones
|
||||
- 📱 **Móvil**: Adaptado para pantallas pequeñas
|
||||
- 📲 **Tablet**: Experiencia optimizada para tablets
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Características de la UI
|
||||
|
||||
- **Diseño moderno**: Gradientes y efectos glassmorphism
|
||||
- **Animaciones suaves**: Transiciones y hover effects
|
||||
- **Feedback visual**: Estados de carga y confirmación
|
||||
- **Tema oscuro**: Colores elegantes y profesionales
|
||||
- **Iconos**: Emojis para mejor identificación visual
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ API Endpoints
|
||||
|
||||
El dashboard expone una API REST:
|
||||
|
||||
- `GET /api/files` - Obtener lista de archivos
|
||||
- `POST /api/reprocess` - Reprocesar archivo
|
||||
- `POST /api/mark-unprocessed` - Marcar como no procesado
|
||||
- `GET /api/refresh` - Refrescar lista
|
||||
- `GET /health` - Health check
|
||||
- `GET /downloads/<archivo>` - Descargar archivo
|
||||
|
||||
---
|
||||
|
||||
## 🚨 Notas Importantes
|
||||
|
||||
### Logs
|
||||
Los logs del dashboard aparecen en la consola donde ejecutaste `main.py`
|
||||
|
||||
### Errores Comunes
|
||||
1. **Puerto 5000 en uso**
|
||||
- Solución: Cambiar puerto en `dashboard.py` o terminar proceso anterior
|
||||
|
||||
2. **No aparecen archivos**
|
||||
- Verificar conexión a Nextcloud
|
||||
- Revisar variables de entorno NEXTCLOUD_*
|
||||
- Comprobar que hay archivos en la carpeta Audios
|
||||
|
||||
3. **Error al procesar**
|
||||
- Revisar logs en la consola
|
||||
- Verificar dependencias (Flask, etc.)
|
||||
- Comprobar espacio en disco
|
||||
|
||||
### Rendimiento
|
||||
- El dashboard se ejecuta en **hilo separado**
|
||||
- **No bloquea** el procesamiento principal
|
||||
- Se inicia **automáticamente** con main.py
|
||||
- **Cierre seguro** al terminar main.py
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Casos de Uso
|
||||
|
||||
### 📚 Estudio Personal
|
||||
1. Sube audios de clases a Nextcloud
|
||||
2. El sistema los procesa automáticamente
|
||||
3. Usa el dashboard para descargar resúmenes
|
||||
4. Estudia con los documentos DOCX generados
|
||||
|
||||
### 🏢 Oficina
|
||||
1. Configura Nextcloud empresarial
|
||||
2. Comparte carpeta Audios con el equipo
|
||||
3. Todos pueden subir archivos para procesar
|
||||
4. Gestiona todo desde el dashboard web
|
||||
|
||||
### 🔄 Reprocesamiento
|
||||
1. Un archivo falló al procesarse
|
||||
2. Usa el dashboard para resetearlo
|
||||
3. Reprocesa con un click
|
||||
4. Descarga el resultado actualizado
|
||||
|
||||
---
|
||||
|
||||
## 🎉 ¡Disfruta!
|
||||
|
||||
**Simplemente ejecuta:**
|
||||
```bash
|
||||
python3 main.py
|
||||
```
|
||||
|
||||
**Y visita:** http://localhost:5000
|
||||
|
||||
---
|
||||
|
||||
### ¿Necesitas Ayuda?
|
||||
|
||||
1. Revisa los logs en la consola
|
||||
2. Verifica que Flask esté instalado: `pip3 install flask flask-cors`
|
||||
3. Comprueba que el puerto 5000 esté libre
|
||||
4. Asegúrate de tener conexión a Internet para APIs de IA
|
||||
|
||||
**¡El dashboard está listo para usar!** 🚀
|
||||
Reference in New Issue
Block a user