FitHub

Índice

1. Introducción
2. Requisitos Previos
3. Clonar el Repositorio
4. Configuración del Backend
   • 4.1 Instalar Dependencias
   • 4.2 Configurar la Base de Datos
5. Configuración del Frontend
   • 5.1 Instalar Dependencias
   • 5.2 Arrancar el Frontend
6. Resumen de los Pasos Iniciales
7. Usuarios

1. Introducción

FitHub es una aplicación web móvil diseñada para centralizar y optimizar el seguimiento del progreso en el gimnasio.

Permite a los usuarios registrar los resultados de sus entrenamientos y generar estadísticas útiles, facilitando la personalización de rutinas, entrenamientos y selección de ejercicios de una manera eficiente.

Al consolidar toda la información necesaria en una sola plataforma, elimina la necesidad de consultar múltiples fuentes externas, simplificando el proceso de análisis y adaptación de la planificación para maximizar los resultados.

2. Requisitos Previos

Antes de comenzar, asegúrate de tener instalado lo siguiente:

• Git: Para clonar el repositorio.
• Java JDK 17 o superior: Requerido para ejecutar el backend.
• Maven: Para gestionar las dependencias del backend.
• Node.js y npm: Requeridos para ejecutar el frontend.
• Base de datos PostgreSQL: Necesaria para almacenar los datos del proyecto.
• DBeaver (opcional): Herramienta para explorar y gestionar la base de datos.

---

3. Clonar el Repositorio

1. Abre una terminal y navega al directorio donde deseas clonar el proyecto.

2. Clona el repositorio usando el siguiente comando:

   git clone https://github.com/EduFergo/FitHub.git

3. Cambia al directorio del proyecto:

   cd FitHub

4. Configuración del Backend

4.1 Instalar Dependencias

1. Cambia al directorio del backend:

   cd fithub-backend

2. Instala las dependencias usando Maven:

   mvn clean install

   O arranca el proyecto con un IDE como IntelliJ con el comando:

   idea .

   Y hágalo manualmente desde el entorno de desarrollo.

4.2 Configurar la Base de Datos

1. Asegúrate de que PostgreSQL está en ejecución.

2. Abre un cliente PostgreSQL o una herramienta como DBeaver (recomendado) y crea una base de datos llamada fithub.

3. Configura las credenciales de acceso:

   • La configuración del archivo application.yml indica que el backend espera conectarse a la base de datos con las siguientes credenciales:
     • Usuario: postgres
     • Contraseña: 1234
   • Si estas credenciales no coinciden con las de tu configuración local, actualízalas en el archivo application.yml ubicado en fithub-backend/src/main/resources/application.yml.

4. Verifica el acceso a la base de datos:

   • Es necesario que dentro de la base de datos exista un esquema llamado public para poder ejecutar los scripts que vienen integrados en el backend. En este proyecto, el sistema de migraciones FlyWay no crea las tablas, solo genera los scripts una vez que Hibernate se haya encargado de crearlas.

5. Arranca el backend:

   • Con el IDE (recomendación IntelliJ), ejecuta el proyecto. El puerto especificado en el archivo application.yml es el 8085.

5. Configuración del Frontend

5.1 Instalar Dependencias

1. Desde la carpeta del proyecto, accede al directorio del frontend:

   cd fithub/fithub-frontend

2. Abre la carpeta con un IDE (recomendación VSCode):

   code .

3. Instala las dependencias usando npm:

   npm install

5.2 Arrancar el Frontend

1. Una vez terminada la instalación, ejecuta el siguiente comando para arrancar el frontend:

   npm run dev

6. Resumen

1. Instalar Herramientas Necesarias: Asegúrate de tener Git, Java JDK 17 o superior, Maven, Node.js, npm, y PostgreSQL instalados. DBeaver es opcional pero recomendado.
2. Clonar el Repositorio: Ejecuta git clone https://github.com/EduFergo/FitHub.git y navega al directorio del proyecto con cd FitHub.
3. Backend:
   • Navega al directorio del backend con cd fithub-backend.
   • Instala las dependencias con mvn clean install o usa un IDE como IntelliJ para abrir el proyecto (idea .).
   • Configura la base de datos PostgreSQL y actualiza las credenciales en application.yml si es necesario.
   • Asegúrate de que el esquema public existe y arranca el backend desde el IDE.
4. Frontend:
   • Navega al directorio del frontend con cd fithub/fithub-frontend.
   • Abre el proyecto con un IDE como VSCode (code .) e instala las dependencias con npm install.
   • Arranca el frontend con npm run dev.

7. Usuarios

Nombre de usuario	Contraseña
admin	admin
user	user