/PI-dogs-Proyect

PI dogs Proyect client and api

Primary LanguageJavaScript

HenryLogo

DOGS | Proyecto Individual

📌 OBJETIVOS

  • Construir una Single Page Application utlizando las tecnologías: React, Redux, Node, Express y Sequelize.
  • Poner en práctica recursos básicos de estilos y diseño (UX : UI).
  • Afirmar y conectar los conceptos aprendidos en la carrera.
  • Aprender mejores prácticas.
  • Aprender y practicar el workflow de GIT.
  • Utilizar y practicar testing.

⏱ HORARIOS Y FECHAS

El proyecto individual tiene una duración máxima de tres semanas. Se inicia la primera semana con un Kick-Off, y se agendará una corrección personalizada la última semana.

En el caso de completar todas las tareas antes de dicho lapso se podrá avisar a su instructor para coordinar una fecha de presentación del trabajo (DEMO).


⚠️ IMPORTANTE

Es necesario contar minimamente con la última versión estable de NodeJS y NPM. Asegúrate de contar con ella para poder instalar correctamente las dependecias necesarias para correr el proyecto. Actualmente las versiónes necesarias son:

  • Node: 12.18.3 o mayor
  • NPM: 6.14.16 o mayor

Para verificar que versión tienes instalada:

node -v
npm -v

ACLARACIÓN: las dependencias actuales se encuentran en las versiones que venimos trabajando durante el bootcamp.

  • react: 17.0.1
  • react-dom: 17.0.1
  • react-router-dom: 5.2.0
  • redux: 4.0.5
  • react-redux: 7.2.3

Está permitido, bajo tu responsabilidad, actualizar las dependencias a versiones más actuales si lo deseas. Versiones mas actuales podrían presentar configuraciones diferentes respecto a las versiones en las que venimos trabajando durante el bootcamp.

⛔️ Está rotundamente prohibido utilizar librerías externas para aplicar estilos a la SPA. Tendrás que utilizar CSS mediante algunas de las opciones vistas en el bootcamp (CSS puro, CSS Modules o Styled Components).


📋 PARA COMENZAR...

  1. Deberás forkear este repositorio para tener una copia del mismo en tu cuenta personal de GitHub.

  2. Clona el repositorio en tu computadora para comenzar a trabajar. Este repositorio contiene un BoilerPlate con la estructura general del proyecto, tanto del servidor como del cliente. El boilerplate cuenta con dos carpetas: api y client. En estas carpetas estará el código del back-end y el front-end respectivamente.

  3. En la carpeta api deberás crear un archivo llamado: .env que tenga la siguiente forma:

        DB_USER=usuariodepostgres
    DB_PASSWORD=passwordDePostgres
    DB_HOST=localhost

  4. Reemplazar usuariodepostgres y passwordDePostgres con tus propias credenciales para conectarte a postgres. Este archivo va ser ignorado en la subida a github, ya que contiene información sensible (las credenciales).

  5. Adicionalmente será necesario que crees, desde psql (shell o PGAdmin), una base de datos llamada dogs. Si no realizas este paso de manera manual no podrás avanzar con el proyecto.


📖 ENUNCIADO GENERAL

La idea de este proyecto es construir una aplicación web a partir de la API TheDogApi y en la que se pueda:

  • Buscar perros.
  • Visualizar la información de los perros.
  • Filtrarlos.
  • Ordenarlos.
  • Crear nuevos perros.

⚠️ Para las funcionalidades de filtrado y ordenamiento NO se puede utilizar los endpoints de la API externa que ya devuelven los resultados filtrados u ordenados.

IMPORTANTE: para poder utilizar la API es necesario crear una cuenta y obtener una ApiKey que luego deberá ser incluida en todos los request que hagamos. Esto se logra simplemente agregando ?api_key={YOUR_API_KEY} al final de cada end-point. Agregar la clave en el archivo .env para que la misma no se suba al repositorio por cuestiones de seguridad.

Únicos end-points que se pueden utilizar


📁 INSTRUCCIONES


🖱 BASE DE DATOS

Deberás crear dos modelos para tu base de datos. Una será para las razas de perros y la otra será para los temperamentos (pueden llevar el nombre que tu quieras). La relación entre ambos modelos debe ser de muchos a muchos. A continuación te dejamos todas las propiedades que debe tener cada modelo.

📍 MODELO 1 | Dogs

  • ID.*
  • Imagen.*
  • Nombre.*
  • Altura.*
  • Peso.*
  • Años de vida.*

📍 MODELO 2 | Temperaments

  • ID.*
  • Nombre.*


🖱 BACK-END

Para esta parte deberás construir un servidor utilizando NodeJS y Express. Tendrás que conectarlo con tu base de datos mediante Sequelize.

Tu servidor deberá contar con las siguientes rutas:

📍 GET | /dogs

  • Obtiene un arreglo de objetos, donde cada objeto es la raza de un perro.

📍 GET | /dogs/:idRaza

  • Esta ruta obtiene el detalle de una raza específica. Es decir que devuelve un objeto con la información pedida en el detalle de un perro.
  • La raza es recibida por parámetro (ID).
  • Tiene que incluir los datos de los temperamentos asociadas a esta raza.
  • Debe funcionar tanto para los perros de la API como para los de la base de datos.

📍 GET | /dogs/name?="..."

  • Esta ruta debe obtener todas aquellas razas de perros que coinciden con el nombre recibido por query. (No es necesario que sea una coincidencia exacta).
  • Debe poder buscarlo independientemente de mayúsculas o minúsculas.
  • Si no existe la raza, debe mostrar un mensaje adecuado.
  • Debe buscar tanto los de la API como los de la base de datos.

📍 POST | /dogs

  • Esta ruta recibirá todos los datos necesarios para crear un nuevo perro y relacionarlo con los temperamentos asociados.
  • Toda la información debe ser recibida por body.
  • Debe crear la raza de perro en la base de datos, y esta debe estar relacionada con los temperamentos indicados (al menos uno).

📍 GET | /temperaments

  • Obtiene todos los temperamentos existentes.
  • Estos deben ser obtenidos de la API (se evaluará que no haya hardcodeo). Luego de obtenerlos de la API, deben ser guardados en la base de datos para su posterior consumo desde allí.


🖱 FRONT-END

Se debe desarrollar una aplicación utilizando React y Redux que contenga las siguientes vistas:

📍 LANDING PAGE | deberás crear una página de inicio o bienvenida con:

  • Alguna imagen de fondo representativa al proyecto.
  • Botón para ingresar a la home page.

📍 HOME PAGE | la página principal de tu SPA debe contener:

  • SearchBar: un input de búsqueda para encontrar razas de perros por nombre.
  • Sector en el que se vea un listado de cards con los perros. Al iniciar deberá cargar los primeros resultados obtenidos desde la ruta GET /dogs y deberá mostrar su:
    • Imagen.
    • Nombre.
    • Temperamentos.
    • Peso.
  • Cuando se le hace click a una Card deberá redirigir al detalle de esa raza específica.
  • Botones/Opciones para filtrar por temperamentos, y por si su origen es de la API o de la base de datos (creados por nosotros desde el formulario).
  • Botones/Opciones para ordenar tanto ascendentemente como descendentemente las razas de perros por orden alfabético y por peso.
  • Paginado: el listado de razas de perros se hará por partes. Tu SPA debe contar con un paginado que muestre un total de 8 perros por página.

⚠️ IMPORTANTE: se deben mostrar tanto las razas de perros traidas desde la API como así también las de la base de datos, pero NO está permitido almacenar en la base de datos las razas de perros de la API. Solamente se pueden guardar aquellas creadas desde el form.


📍 DETAIL PAGE | en esta vista se deberá mostrar toda la información específica de un perro:

  • ID.
  • Imagen.
  • Nombre.
  • Altura.
  • Peso.
  • Temperamentos.
  • Años de vida.

📍 FORM PAGE |: en esta vista se encontrará el formulario para crear una nueva raza de perro.

Este formulario debe ser controlado completamente con JavaScritp. No se pueden utilizar validaciones HTML, ni utilizar librerías especiales para esto. Debe contar con los siguientes campos:

  • Nombre.
  • Altura (diferenciar entre altura mínima y máxima de la raza).
  • Peso (diferenciar entre peso mínimo y máximo de la raza).
  • Años de vida.
  • Posibilidad de seleccionar/agregar varios temperamentos en simultáneo.
  • Botón para crear la nueva raza.

[IMPORANTE]: es requisito que el formulario de creación esté validado sólo con JavaScript. Puedes agregar las validaciones que consideres. Por ejemplo: que el nombre de la raza no pueda contener números, o que el peso/altura mínimo no pueda ser mayor al máximo.



🖱 TESTING

Ten en cuenta que en esta instancia no es obligatorio el desarrollo de testing para tu aplicación. De igual manera, te desafiamos a que los hagas, ¡ya que suman puntos!

  • Al menos tener un componente del frontend con sus tests respectivos.
  • Al menos tener dos rutas del backend con sus tests respectivos.
  • Al menos tener un modelo de la base de datos con sus tests respectivos.