Esta es una prueba técnica para la una postulación de trabajo. Este documento explica cómo levantar el proyecto y correr las pruebas. Puede probar la aplicación aqui: https://planify-challenge-kristhdev.vercel.app.
Este proyecto usa una API para obener los datos, está se encuentra en el siguiente repositorio: PlanifyChallenge-backend. Lo puede clonar para ejecutarlo en su equipo o de lo contrario puede usar la url
del api desplegada https://planify-challenge-backend.vercel.app
.
Lo primero que se debe hacer es clonar el repositorio con el siguiente comando:
git clone https://github.com/KristhDev/PlanifyChallenge-frontend.git
Ahora se deben instalar las dependencias del proyecto, haga un cd
al directorio del proyecto y ejecute el siguiente comando:
pnpm install
Como habra notado el proyecto usa pnpm como gestor de dependencias, pero no está obligado a usarlo, puede cambiarlo por yarn o npm.
Solo asegurese de borrar el archivo pnpm-lock.yaml
.
El proyecto tiene el archivo .env con la variable VITE_API_URL y la dirección local del API, lo puede dejar así o cambiar por la URL del API desplegada. En un escenario real este tipo de archivo no se sube al repositorio, pero al ser una prueba técnica y no ser una aplicación real, considere que no hay problema en subirlo.
Ya con las dependencias instaladas y con el API corriendo en su equipo o usando la URL del API desplegada ejecute el siguiente comando:
pnpm dev
Y listo ya podrá abrir el proyecto en el navegador http://localhost:5173.
En el proyecto se realizó el testing para garantizar el correcto funcionamiento del proyecto y la detección de errores.
En la rama de testing se encuentran todas las pruebas, por lo que primero hay que moverse a esa rama, eso se hace con este comando:
git switch testing
Ahora se deben instalar las dependencias del proyecto, haga un cd
al directorio del proyecto y ejecute el siguiente comando:
pnpm install
Recuerde que siempre debe tener las variables de entorno en el archivo .env. Esas son las mismas que en la sección 1.3.
Hay varios comandos para ejecutar los pruebas, con distintos propositos, esos son:
Ese comando es para ejecutar todos los pruebas que se encuentren:
pnpm test
Ese comando es para ejecutar los pruebas unitarios, que se encuentran en el directorio unit dentro de tests:
pnpm test:unit
Vitest da un modo UI para ver las pruebas desde el navegador y ver como se conectan los tests entre si:
pnpm test:ui
El coverage es para crear un reporte que mostrará el porcentaje de pruebas que se han ejecutado y código comprobado, este crea un directorio coverage dentro de carpeta tests:
pnpm test:coverage