Saltar al contenido principal

Software Review Guidelines

MUSCLEMATE

Musclemate, Grupo 3, WPL​

VersiónFechaAutorDescripción
v1.02024-04-22Angel MuñozCreación del documento
v1.12024-04-22Alejandro SosaAdición de datos pedidos en la Software Review Guidelines
v1.22024-05-06Alejandro SosaEliminación completa de contraseñas (se enviarán aparte)
v1.32024-05-06David DanaMejora del documento
v1.42024-05-19David DanaCorreción de erratas y actualización

Despliegue del Docusaurus para el acceso a la documentación

Para poder desplegar docusaurus en su equipo debe seguir los siguientes pasos:

  • Primero debe asegurarse de tener instalado Node.js y npm en su equipo.
  • Después clonar el repositorio, "git clone https://github.com/ISPP-23-24-Grupo-3/MuscleMate-Documentation.git"
  • A continuación entrar al repo con "cd MuscleMate-Documentation" y una vez dentro del repositorio ejecutar el siguiente comando: "cd .\MuscleMate" para entrar a la carpeta MuscleMate
  • Ahora hacer "npm install"
  • Por ultimo hacer "npm run start"

Tenga en consideración que una vez hecho el "npm run start" se abrirá automáticamente la página web en local pero el proceso se puede demorar varios minutos, aunque le salga la url por consola puede que aún tenga que compilar asi que si la página le sale en blanco puede que deba esperar unos minutos más. Otra consideración importante es que siempre debe estar hacer el start desde la carpeta MuscleMate.

Inicio de Sesión

En los siguientes apartados se harán referencias a la barra de navegación de la aplicación en la cual hay diversos enlaces, en caso de usar la aplicación en un móvil la barra de navegación se convertirá en un menú desplegable.

Credenciales de Uso

Para probar la aplicación se tienen los siguientes enlaces al despliegue:

Respecto a la tracking tool, la usada es Clockify y ya se proporcionó al profesorado las credenciales para acceder y se le invitó para ver el estado. Respecto a la demo se encuentra en la carpeta Demos en Other Evaluable Docs.

Aunque se puede registrar como se verá más adelante; se recomienda probar las funcionalidades con los siguientes usuarios para ver datos ya creados y comprobar de manera más cómoda:

  • Usuarios Cliente:

    • pabmoreno (inscrito en el gimnasio MasMusculoFit Sevilla MMFit Gym el cual tiene suscripción premium)
    • vicvazvaz (inscrito en el gimnasio Synergym Sevilla Palacio de Congresos el cual tiene suscripción estándar)

  • Uusuarios Dueño:

    • aaromo (dueño del gimnasio McFIT Sevilla Palacio de Congresos el cual tiene suscripción premium y del gimnasio MasMusculoFit Sevilla MMFit Gym el cual tiene suscripción premium)
    • raquitori (dueño del gimnasio Synergym Sevilla Nervión el cual tiene suscripción estándar)

Todas las credenciales serán enviadas por mensaje a el profesor por motivos de seguridad.

Cuando trate de suscribirse como dueño de gimnasio a un plan, en la pasarela de pago introduzca de numero de tarjeta "4242 4242 4242 4242", pudiendo inventarse el resto de datos.

Inicio de Sesión

En la esquina superior derecha se encuentran los botones para iniciar sesión y para registrarse. Puede o bien pulsar el botón de entrar o el que pone 'Iniciar Sesion' para acceder a la pantalla que procesa esto. Una vez en la pantalla rellene el formulario con los datos proporcionados para iniciar sesión correctamente como cliente o propietario.

Perfil

Sea cliente o propietario se puede acceder en todo momento a su perfil pulsando sobre su nombre en la esquina derecha.

Funcionalidades de Cliente

Una vez inicia sesión sale una pantalla principal desde que la que podrá acceder rapidamente a las 3 funcionalidades principales de cliente; Mis rutinas, Mis eventos y Mi historial.

Mis Rutinas​

Si inicia sesión como pabmoreno, podrá ver una ya. Para crear una nueva pulse sobre "Mis Rutinas" en el menú principal o sobre Rutinas en la barra de navegación y una vez dentro pulse en "Añadir Rutina". Con esto podra incluir un nombre y crear una rutina de momento vacía.

A estas rutinas se les puede añadir ejercicios pulsando sobre el icono del lápiz. Ahí llegamos a la pantalla de ejercicios donde se pueden añadir ejercicios pulsado en "Añadir Ejercicio" e introduciendo un nombre y ninguna, una o más de una máquinas del gimnasio al que esté apuntado. Luego confirma la creación con el check verde. Estos ejercicios se pueden editar o borrar con los iconos del lápiz y de la X roja. En esta pantalla también se puede editar el nombre de la rutina con el lápiz que sale al lado del nombre.

Mediante el boton de "entrenar" en esta pantalla o el símnolo de mancuerna (pesa) en la anterior se entra en la pantalla de entrenamiento. En esta pantalla pulsando en cualquiera de los ejercicios se puede acceder a un cronómetro para marcar los descansos, que se reinicia solo cada vez que se para y se pueden crear series sobre el ejercicio añadiendo un peso, unas repeticiones y un tiempo (ningun campo es obligatorio ya que puede querer hacer ejercicios que solo dependan del tiempo por ejemplo), que luego servirán para crear las gráficas de evolución de repeticiones y peso.

Pulsando en "estadisticas" en esta misma pantalla o pulsando en "Mi Historial" en el menu principal o "Historial" en la barra de navegación, podemos acceder a gráficas sobre el peso o las repeticiones según una máquina en particular (la página del historial puede tardar algunos segundos en cargar debido al servidor de backend).

Mis eventos​

Desde el menú principal podemos usar el botón "Mis Eventos" o con la barra de navegación usando el botón "Eventos", para acceder a un listado de eventos disponibles para el gimnasio al que estemos apuntados, en el que se puede buscar por nombre. Pulsando sobre uno podemos ver los detalles y hacer una reserva de uno o eliminar una reserva si ya la tenemos (aunque es necesario recargar para esto).

Incidencias​

Desde la barra de navegación podemos usar el botón "Crear incidencia" donde completando los datos y la máquina afectada abrimos una incidencia que podra ver el dueño del gimnasio en su listado.

Al crear una se redirige a la pantalla de "Tus Incidencias" donde se listan todas las incidencias creadas y su estado actual, también accesible desde la barra de navegación con el botón "Mis incidencias".

Máquinas​

Entrando desde la barra de navegación en "Máquinas del Gimnasio" podemos acceder a un listado de las máquinas del gimnasio al que se pertenece y un buscador y varios filtros para esto (el panel a la derecha del buscador)

Pulsando sobre una máquina accedemos a los detalles de una máquina dónde podemos añadir una incidencia directamente unida a ella o valorarla pulsando sobre las estrellas en la cantidad seleccionada y luego en "enviar".

Cerrar Sesión​

Por último pulsamos sobre "Salir" en la barra de navegación y cerramos sesión.

Funcionalidades de Propietario

Registro​

Según el modelo de Musclemate solo los propietarios se podrán registran ellos mismos; para ello sin una sesión iniciada pulse en el registro en lugar de iniciar sesión en la esquina y rellene el formulario con datos correctos. Una vez registrado podrá iniciar sesión con estos datos.

Administrar máquinas​

Una vez iniciada sesión se puede acceder al listado de las máquinas de los gimnasios que pertenecen al propietario desde el botón "Mis Máquinas" de la barra de navegación o desde el menú principal con el boton "Administrar máquinas". Ahí se puede añadir una máquina desde el botón para añadirlas completando correctamente el formulario, buscar una máquina por nombre y aplicar diversos filtros (funcionan igual que los vistos para cliente)

Pulsando sobre una máquina podemos ver los detalles de esta (que son editables) y las incidencias relacionadas (en caso de existir), que se pueden marcar como resueltas o no resueltas mediante el checkbox que poseen.

Registrar cliente​

Pulsando ese botón en el menú principal se accede al registro de cliente. Como se ha explicado antes, por si mismo solo se registra el propietario. Esto es porque el propietario (o el perfil de gimnasio) es quien registra a los clientes de su propio gimnasio y luego les cede su usuario y contraseña para que usen la app.

Rellenando este formulario se crea un usuario en el gimnasio que el dueño seleccione (de los que son de su propiedad).

Administrar usuarios​

Pulsando sobre ese botón en el menú principal o en "Usuarios" en la barra de navegación se accede al listado de usuarios en los gimnasios que dispone el propietario. También se dispone de un buscador y filtros como en listados anteriores.

Pulsando sobre un cliente se accede al perfil de este, desde donde se puede editar su información.

Administrar incidencias​

Pulsando sobre ese botón en el menú principal o en la barra de navegación usando el botón "Incidencias" se accede al listado de incidencias, que se pueden buscar por máquina o gimnasio y marcar como resuelto o no resuelto según sea necesario.

Administrar Gimnasios​

Pulsando sobre ese botón en el menú principal o pulsando en "Mis gimnasios" en la barra de navegación se puede acceder al listado de gimnasios del propietario. Se pueden filtrar por nombre o crear mediante el botón "Crear Nuevo Gimnasio", que redirige a un formulario que los crea. Al crear un nuevo gimnasio se creará también un usuario propio de el gimnasio similar a el de dueño pero con funcionalidades limitadas a dicho gimnasio (usable por empleados u otras entidades relacionadas con el gimnasio).

Pulsando sobre un gimnasio podremos ver sus detalles y desde ahi se puede eliminar un gimnasio o ver sus estadísticas. Estas estadísticas consisten en un gráfico del uso de las máquinas en el tiempo.

Administrar eventos​

Pulsando sobre ese botón en el menú principal se accede a un listado de los eventos de tus gimnasios con su debido buscador y filtros.

Mediante el botón "Añadir Evento" se puede crear uno mediante un formulario al que se redirige.

Pulsando sobre un evento se accede a los detalles de este, pudiendo editarlos desde este menú. Así como a un botón para eliminarlo si se considerase necesario.

Pagos y Suscripciones​

Mediante el botón de la barra de navegación "Planes" podemos seleccionar un plan y pagarlo para un gimnasio en concreto, con el botón "Suscripciones" podrás ver el estado de las suscripciones de tus gimnasios.

En "Planes" tras seleccionar un plan se le redijirá a una pantalla donde seleccionamos para que gimnasio es y luego a la plataforma Stripe. Ahí se completa con los datos proporcionados al principio y con ello se llevaría a cabo la suscripción.

En "Suscripciones" puede listarlas todas y cancelar alguna si se estimase necesario.

Para el pago emplear el siguiente numero de tarjeta "4242 4242 4242 4242", el resto de datos se pueden inventar.