vvillarreal-cfee commited on
Commit
a18e022
·
1 Parent(s): e0c9b20

Update README.md to enhance project description and usage instructions

Browse files
Files changed (1) hide show
  1. README.md +51 -5
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- title: Generador Post Mortem
3
  emoji: 🚀
4
  colorFrom: red
5
  colorTo: red
@@ -12,9 +12,55 @@ short_description: Generador de Informes Post-Mortem AI
12
  license: apache-2.0
13
  ---
14
 
15
- # Welcome to Streamlit!
16
 
17
- Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
18
 
19
- If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
20
- forums](https://discuss.streamlit.io).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Generador informes Post Mortem
3
  emoji: 🚀
4
  colorFrom: red
5
  colorTo: red
 
12
  license: apache-2.0
13
  ---
14
 
15
+ # Generador de Informes Post-Mortem con Gemini AI
16
 
17
+ > Aplicación web para generar informes post-mortem técnicos de incidentes IT, asistida por inteligencia artificial (Google Gemini). Permite pegar el texto raw de una alerta/incidente, precompletar los campos clave automáticamente y generar un informe profesional en formato Markdown.
18
 
19
+ ## Características principales
20
+
21
+ - Cuadro de texto libre para pegar el mensaje raw de la alerta/incidente.
22
+ - Botón para precompletar los campos del formulario usando IA (Gemini).
23
+ - Formulario editable para revisar y ajustar los datos extraídos antes de generar el informe.
24
+ - Generación automática de un informe post-mortem estructurado y descargable en Markdown.
25
+ - Configuración sencilla de la API Key de Gemini desde el panel lateral.
26
+
27
+ ## ¿Cómo usar la aplicación?
28
+
29
+ 1. **Configura tu API Key de Gemini** en el panel lateral.
30
+ 2. **Pega el texto raw** de la alerta o incidente en el cuadro superior.
31
+ 3. Haz clic en **"Precompletar campos con IA"** para que la IA extraiga y complete los campos del formulario.
32
+ 4. **Revisa y edita** los campos precompletados según sea necesario.
33
+ 5. Haz clic en **"Generar Informe Post-Mortem"** para obtener el informe estructurado.
34
+ 6. Descarga el informe generado en formato Markdown.
35
+
36
+ ## Ejecución en entorno de desarrollo
37
+
38
+ ### Requisitos previos
39
+
40
+ - Python 3.9+
41
+ - [Streamlit](https://streamlit.io/)
42
+ - API Key de Google Gemini (Gemini AI)
43
+
44
+ ### Instalación de dependencias
45
+
46
+ ```bash
47
+ pip install -r requirements.txt
48
+ ```
49
+
50
+ ### Ejecución de la app
51
+
52
+ ```bash
53
+ streamlit run src/streamlit_app.py
54
+ ```
55
+
56
+ Esto abrirá la aplicación en tu navegador en [http://localhost:8501](http://localhost:8501).
57
+
58
+ ## Notas útiles
59
+
60
+ - La API Key de Gemini se ingresa desde el panel lateral de la app.
61
+ - Los datos pegados en el cuadro de texto raw **no se envían automáticamente**: el usuario debe revisar y confirmar antes de generar el informe.
62
+ - El informe generado puede descargarse en formato Markdown para su uso o distribución.
63
+
64
+ ## Licencia
65
+
66
+ Este proyecto se distribuye bajo la licencia Apache 2.0.