Examenes-Viejos-Web

Una plataforma web para facilitar el acceso a exámenes antiguos almacenados en formato PDF e imágenes en un repositorio de GitHub ExamenesViejos-FaMAF-Computacion.

Sitio web 🌐

Podes acceder a la web en este enlace.

Colabora con código 🤝💻

Si deseas contribuir con código, por favor:

1. Haz un fork del Proyecto.
2. Clona tu fork .
3. Añade el repositorio original como remoto: git remote add upstream https://github.com/ramiro-l/Examenes-Viejos-Web
4. Crea tu Rama de Funcionalidad: git checkout -b feature/CaracteristicaIncreible
5. Realiza tus cambios y seguí las convenciones para los commits.
6. Asegúrate de seguir las guías de estilo pra el código.
7. Haz Push a la Rama: git push origin feature/CaracteristicaIncreible
8. Abre una pull request con una descripción detallada de los cambios propuestos y referencia al problema relacionado.

[!NOTE]

1. En caso de error al crear los commits ejecutar pnpm run format porque se esta usando husky para garantizar la consistencia en los estilos.
2. Tambien puede ser porque no se esta siguiendo el formato de los commits, para mas informacion ver Formato de los Commits. Generalmente estos errores sugen al hacer merge, porque te auto completa el mensaje del commit.

Contribuye con ideas, errores o comentarios 💡

Si tienes una idea, encuentras un error o deseas dar feedback sobre el proyecto:

• Abre un nuevo problema en el repositorio describiendo tu idea, el error que encontraste o el feedback que deseas compartir.

• Sé lo más detallado posible en la descripción.

• Si es posible, incluye capturas de pantalla u otros recursos que puedan ayudar a entender mejor tu punto.

Formato de los Commits 📝

Las convenciones de commit utilizadas en este proyecto son las siguientes:

• Tipo de Commit: El tipo de commit proporciona contexto sobre el cambio realizado. Algunos ejemplos comunes incluyen feat para nuevas características, fix para correcciones de errores y docs para cambios en la documentación.

• Ámbito Opcional: El ámbito proporciona información adicional sobre el alcance del cambio, como el módulo o componente afectado.

• Descripción del Cambio: La descripción del cambio debe ser breve pero descriptiva, proporcionando suficiente información para entender el propósito del commit.

Ejemplo de un commit siguiendo estas convenciones:

feat(login): add email validation

[!IMPORTANT] Este proyecto sigue los Conventional Commits para mantener un historial claro y consistente de cambios.

Para obtener más información sobre Commits Convencionales, consulta la web oficial.
Aquí tienes Conventional Commits para VSCode.

Formato del Código 🎨

Este proyecto utiliza Prettier para mantener un estilo de código consistente.

Para formatear el código, ejecuta el siguiente comando:

pnpm run format

Instalación y Ejecución 🛠️

Clonar el repositorio con el siguiente comando:

git clone https://github.com/ramiro-l/Examenes-Viejos-Web.git

Ingresa al directorio del proyecto cd Examenes-Viejos-Web y ejecuta el siguiente comando para instalar las dependencias:

pnpm install

Esto es opcional pero puedes configurar las variables de entorno en un archivo .env en la raíz del proyecto. Puedes copiar el archivo .env.example y renombrarlo a .env para configurar las variables de entorno. Especiamente la variable GITHUB_ACCESS_TOKEN que es necesaria para realizar las consultas a la API de GitHub. Si no se configura, no pasa nada, se utilizan respuestas de prueba que estan en ./src/services/examenes/examples-fetch.

Finalmente para ejecutar la aplicación en modo de desarrollo:

pnpm dev

Se utiliza pnpm como gestor de paquetes pero puedes utilizar npm o el que prefieras.