diff --git a/README.md b/README.md index c717e841..2740da7c 100644 --- a/README.md +++ b/README.md @@ -2,971 +2,77 @@ ## Índice -* [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. Criterios de aceptación mínimos del proyecto](#6-criterios-de-aceptación-mínimos-del-proyecto) -* [7. Hacker edition](#7-hacker-edition) -* [8. Objetivos de aprendizaje](#8-objetivos-de-aprendizaje) -* [9. Pistas, tips y lecturas complementarias](#9-pistas-tips-y-lecturas-complementarias) -* [10. Consideraciones para pedir tu Project Feedback](#10-consideraciones-para-pedir-tu-project-feedback) +* [1. Introducción](#1-introducción) +* [2. Descripción del proyecto](#2-Descripción-del-proyecto) +* [3. Funcionalidades](#3-funcionalidades) +* [4. Historia de usuario](#4-Historia-de-usuario) +* [5.Tecnologías utilizadas](#5-Tecnologías-utilizadas) +* [6. Diseño y Desarrollo del Prototipo](#6-Diseño-y-Desarrollo-del-Prototipo) -*** +## 1. Introducción +¡Bienvenido a WikiNook 🏡! +Este proyecto es una aplicación web dedicada a los amantes del videojuego Animal Crossing, específicamente diseñada para explorar y conocer más sobre los adorables vecinos del juego. Con un diseño inspirado en la estética de Animal Crossing, WikiNook ofrece una experiencia interactiva para descubrir información detallada sobre cada vecino, clasificándolos según su especie, personalidad y género. -## 1. Preámbulo +## 2. Descripción del proyecto +WikiNook tiene como objetivo proporcionar a los jugadores de Animal Crossing una plataforma intuitiva y atractiva para explorar información detallada sobre sus vecinos favoritos. Desde clasificar a los vecinos por personalidad y especie hasta la posibilidad de buscarlos por nombre, WikiNook es la guía perfecta para conocer a fondo la comunidad animal de tu isla. -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. +![Imagen página completa gif](WikiNook.gif) -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_. +## 3. Funcionalidades -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. +* Exploración por Filtros: Filtra a los vecinos por personalidad, especie y género, esta sección cuenta con un botón de limpiado de dichos filtros y devuelve los datos a su estado inicial. +* Orden Alfabético: Explora la lista de vecinos de manera ascendente o descendente por orden alfabético a través de un selector. +* Barra de Búsqueda: Encuentra rápidamente a tu vecino favorito por su nombre, cuenta con un botón que limpia la búsqueda realizada. +* Estadísticas: Muestra porcentualmente en un modal la cantidad de vecinos del género femenino y del género masculino existentes en la plataforma. -![pokemon-data-to-ui](https://user-images.githubusercontent.com/12631491/218505816-c6d11758-9de4-428f-affb-2a56ea4d68c4.png) +## 4. Historia de usuario -## 2. Resumen del proyecto +Se realizo un documento con las funcionalidades del proyecto, pedidas desde el punto de vista de un usuario, simulando una situación en la que podría ser usada. Aquí mostramos el enlace del documento realizada para el usuario que nos permite conocer los pasos en los que se desarrollo el proyecto. +[Enlace del documento](https://docs.google.com/document/d/1K8NoQyA83kZ_FGCIBDcJ6XyT0XXSpx40iVrrJk-1XwY/edit) -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. +## 5. Tecnologías utilizadas +El desarrollo de WikiNook se benefició de un conjunto diverso de tecnologías y herramientas que permitieron una implementación robusta y una experiencia de usuario enriquecedora. -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. +### Prompt utilizado +Se utiliza chatGPT como IA requerida, este nos facilito la extración de información que requeriamos para mostrar la data de las tarjetas. -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). - -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). - -## 3. Consideraciones generales - -* 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/). - -## 4. Funcionalidades - -Como entregable final tendrás una página web que permita **visualizar la data, -filtrarla, ordenarla y calcular alguna estadística**. - -Aquí definimos en más detalle las funcionalidades mínimas que debe tener: - -* 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 `