diff --git a/README.md b/README.md index adb609b..7a77d7f 100644 --- a/README.md +++ b/README.md @@ -1,1056 +1,90 @@ -# Dataverse +![](https://i.ibb.co/VxJVCtk/Screen-Shot-2024-04-05-at-12-05-02.png) -## Índice +## Definición de Producto: -* [1. Preámbulo](#1-preámbulo) -* [2. Resumen del proyecto](#2-resumen-del-proyecto) -* [3. Consideraciones generales](#3-consideraciones-generales) -* [4. Funcionalidades](#4-funcionalidades) -* [5. Consideraciones técnicas](#5-consideraciones-técnicas) -* [6. Hitos](#6-hitos) -* [7. Criterios de aceptación mínimos del proyecto](#7-criterios-de-aceptación-mínimos-del-proyecto) -* [8. Hacker edition](#8-hacker-edition) -* [9. Objetivos de aprendizaje](#9-objetivos-de-aprendizaje) -* [10. Pistas, tips y lecturas complementarias](#10-pistas-tips-y-lecturas-complementarias) -* [11. Consideraciones para pedir tu Project Feedback](#11-consideraciones-para-pedir-tu-project-feedback) +¡Bienvenidos **SharkInfo**! Aquí encontrarás fascinantes datos sobre 24 especies de tiburones, sus hábitats, comportamientos y mucho más. Esta app está diseñado para estudiantes, aficionados de la vida marina y cualquier persona interesada en aprender sobre estos magníficos depredadores marinos. -*** +## **Características Principales:** -## 1. Preámbulo +- **principales Usuarios:** Estudiantes, aficionados y aquellos que desean ampliar su conocimiento sobre tiburones y compartir información con otros. +- **Explora 24 Especies:** Conoce a las especies de tiburones más conocidas del mundo a través de datos detallados y fotografías impresionantes. +- **Información Esencial:** Encuentra datos básicos como el nombre común y científico de cada especie, junto con imágenes de alta calidad en su hábitat natural. +- **Curiosidades y Características:** Descubre hechos fascinantes sobre cada especie, su esperanza de vida, ubicación y hábitos alimenticios. -Según [Forbes](https://www.forbes.com/sites/bernardmarr/2018/05/21/how-much-data-do-we-create-every-day-the-mind-blowing-stats-everyone-should-read), -el 90% de la data que existe hoy ha sido creada durante los últimos dos años. -Cada día generamos 2.5 millones de terabytes de datos, una cifra sin -precedentes. +## **Prompting utilizado para generar la Data** 🤖 -No obstante, los datos por sí mismos son de poca utilidad. Para que esas -grandes cantidades de datos se conviertan en **información** fácil de leer para -las usuarias, necesitamos entender y procesar estos datos. Una manera simple de -hacerlo es creando _interfaces_ y _visualizaciones_. +![](https://i.ibb.co/x26zVn1/promp-1.jpg) +![](https://i.ibb.co/D71fhZZ/promp-2.jpg) -En la siguiente imagen, podrás ver cómo con la data que que se ve en la parte -izquierda se puede construir una interfaz amigable y entendible por las -usuarias, al lado derecho. -![pokemon-data-to-ui](https://user-images.githubusercontent.com/12631491/218505816-c6d11758-9de4-428f-affb-2a56ea4d68c4.png) +## **Historias de Usuario:** -## 2. Resumen del proyecto +1. **Visualización de las imágenes de las 24 especies de tiburones** 👀 -En este proyecto **construirás una _página web_ para visualizar un -_conjunto (set) de datos_** que vas a generar con [prompting](https://www.itmadrid.com/que-es-un-prompt-en-inteligencia-artificial-ia/). -Esta página web se adecuará a lo que descubras que tu usuaria -necesita. + - **Como** estudiante y/o aficionado del mundo de los tiburones. + - **Quiero** poder ver una lista de los tiburones más conocidos del mundo. + - **Para** ampliar mis conocimientos sobre las especies de tiburones, para investigar como parte de un proyecto escolar. -Además, en este proyecto utilizarás herramientas de -[inteligencia artificial](https://es.wikipedia.org/wiki/Inteligencia_artificial) -como [ChatGPT](https://openai.com/chatgpt), [ExplainDev](https://explain.dev/), -entre otras para generar un set de datos en un archivo javascript. + **Criterios de aceptación:** + - Incluir una lista o grilla de tiburones. + - Ver imágenes de alta calidad de las especies de tiburones en su hábitat natural. + - Cada tarjeta debe proporcionar el nombre común y científico del tiburón. + - Se debe incluir una breve descripción de cada especie que destaque sus características distintivas, como tamaño, hábitat y comportamiento. -El propósito de generar los datos en esta manera es brindarte la oportunidad de -adentrarte en el empleo de herramientas impulsadas por la inteligencia -artificial, así como en [técnicas de prompting](https://learnprompting.org/es/docs/intro). +2. **Filtrado y ordenado por hábitat y tamaño de tiburones** 🔎 -Como entregable final tendrás una página web que permita **visualizar la data, -filtrarla, ordenarla y calcular alguna estadística**. Con estadística -nos referimos a distintos cálculos que puedes hacer con los datos para mostrar -información aún más relevante a las usuarias (promedio, el valor máximo -o mínimo, etc). + - **Como** estudiante y/o aficionado del mundo de los tiburones. + - **Quiero** poder filtrar por hábitat y además ordenar por tamaño de forma ascendente y descendente, además poder limpiar los filtro que aplique. + - **Para** observar las diferencias de hábitat y tamaños entre cada especie. -## 3. Consideraciones generales + **Criterios de aceptación:** + - La app debe permitir a los usuarios filtrar la lista de tiburones por hábitat, incluyendo opciones como aguas profundas, aguas tropicales y subtropicales, océano atlántico, océano pacifico y océanos en todo el mundo. + - Se debe proporcionar la opción de ordenar la lista de tiburones por tamaño de forma ascendente y descendente. + - La funcionalidad de filtrado y ordenamiento debe ser intuitiva y fácil de usar para el usuario. + - Debe ser posible filtrar por hábitat y luego ordenar por tamaño. + - Se deben proporcionar opciones claras para deshacer los filtros y restablecer la lista a su estado original si es necesario. + - Se debe realizar pruebas exhaustivas de la funcionalidad de filtrado y ordenamiento para garantizar su correcto funcionamiento en diferentes situaciones y escenarios de uso. -* Este proyecto se debe resolver en duplas. -* El rango de tiempo estimado para completar el proyecto es de 4 a 5 Sprints. -* El tiempo estimado que deberías dedicar a la [generación de los datos](#generar-los-datos) - es de máximo un sprint. Además, al final del proyecto deberás presentar - un [screenshot del prompt utilizado](#prompt-utilizado). -* Si ves que te va a tomar más tiempo, - deberás utilizar los datos de ejemplo que los vas a encontrar en - esta ruta: `./src/data/dataset.js`. -* El proyecto será entregado subiendo tu código a GitHub (commit/push) y la - interfaz será desplegada usando [GitHub Pages](https://pages.github.com/). +3. **Calculo de Longevidad Promedio de los Tiburones** 🧮 -## 4. Funcionalidades + - **Como** estudiante y/o aficionado del mundo de los tiburones. + - **Quiero** poder calcular al accionar un botón y ver el promedio de la longevidad de los tiburones. + - **Para** observar el promedio de la longevidad de todos los tiburones así como al filtrar por hábitat. -Como entregable final tendrás una página web que permita **visualizar la data, -filtrarla, ordenarla y calcular alguna estadística**. + **Criterios de aceptación:** + - La plataforma debe proporcionar un botón claramente visible para calcular el promedio de la longevidad de los tiburones. + - Al hacer clic en el botón de cálculo, se debe mostrar de manera clara y legible el promedio de la longevidad de todos los tiburones presentes en la lista, debe estar expresada en años y la cantidad debe contener 2 decimales. + - Cuando se filtre por hábitat, el cálculo del promedio de la longevidad debe basarse únicamente en los tiburones que pertenecen al hábitat seleccionado. + - La aplicación debe ser responsive en computadores y teléfonos. + - Se debe realizar pruebas exhaustivas para verificar la precisión del cálculo del promedio de la longevidad y la funcionalidad de filtrado y ordenado diferentes situaciones y escenarios de uso. -Aquí definimos en más detalle las funcionalidades mínimas que debe -tener: +## Diseño de la Interfaz de Usuaria (prototipo de alta fidelidad) 💻 -* La aplicación debe permitir a la usuaria ver los items de la data en una visualización, - que puede ser [tipo tarjetas](http://www.uxables.com/diseno-ux-ui/que-es-y-como-disenar-una-card/) - o cualquier otra forma que tú decidas como la adecuada (pero desde aquí - referimos a los items como "tarjetas"). **Cada una de las tarjetas debe estar - contenida en un elemento `
  • ` y estos a su vez contenido en - un elemento `