i4vk/gymmanager repository overview

⁠GymManager

⁠Gestor de usuarios y empleados de un gimnasio

La idea es crear una API que permita manejar una base de datos en la cual se podrán almacenar datos de los clientes suscritos al gimnasio, los cuales podrán tener además distintas tarifas cada uno. Por ejemplo, clientes completos, con acceso al gimnasio todos los días de la semana, o clientes básicos, con acceso un número de días limitado.

De dichos clientes se almacenarán distintos datos que podrían ser útiles, como son por ejemplo del nombre completo, el teléfono, el DNI, y el número de socio, que será único para cada uno de los clientes. También será importante almacenar la tarifa asociada a dicho cliente.

⁠Instalación

buildtool: gulpfile.js

Para instalarlo, primero de todo es necesario clonar el repositorio:

$ git clone https://github.com/i4vk/GymManager.git

Antes de nada, necesitamos tener instalado gulp. Si no es así, necesitamos ejecutar:

$ npm -g install gulp

Posteriormente, instalamos todas las dependencias:

$ npm install

Dado que gulp necesita algunas dependencias dentro del gulpfile.js, no es posible instalar los paquetes usando gulp install. Esta es la razón por la que es necesario hacer npm install.

⁠Uso

Para iniciar el servidor, ejecutaremos:

$ gulp start &

Esto creará una instancia corriendo del servidor. Es necesario poner el símbolo '&' al final del comando para que el terminal no se quede bloqueado, y así poder seguir ejecutando órdenes.

Si queremos detenerla, ejecutaremos lo siguiente:

$ gulp stop

Una vez arrancado el servidor, ya podemos empezar a hacer peticiones a la dirección 127.0.0.1:8080/.

⁠Test

Finalmente, si queremos ejecutar los test, escribiremos el siguiente comando:

$ gulp test

⁠Funcionalidades

Este microservicio formaría parte de una aplicación completa que maneje el sistema informático completo de un gimnasio, tales como los accesos al gimnasio, el registro de clientes, etc.

Sin embargo, la funcionalidad de este microservicio que vamos a desarrollar durante la asignatura va a encargarse únicamente de manejar la base de datos de clientes.
Para llevar a cabo esta función, debe disponer de las siguientes funcionalidades:

• Crear una nueva base de datos de clientes.
• Añadir un nuevo cliente a la base de datos.
• Modificar los datos de alguno de los clientes ya creados.
• Eliminar clientes de la base de datos.
• Consultar la lista completa de clientes.
• Consultar los datos de un cliente específico.

⁠Enlaces a la aplicación

Despliegue: https://gym-manager-iv-1920.herokuapp.com/⁠

Despliegue 2: https://gymmanager-iv-1920.azurewebsites.net/⁠

Contenedor: https://gym-manager-iv-1920.herokuapp.com/⁠

Contenedor 2: https://gym-manager-iv.azurewebsites.net/⁠

⁠Documentación

• Clase principal: GymManager⁠
• API REST: Endpoints⁠
• Herramientas utilizadas: Herramientas⁠
• Herramienta de construcción: Gulpfile⁠
• Integración continua: CI⁠
• Hooks Git: Hooks⁠
• Despliegue en PaaS: Despliegue⁠
• Docker: Docker⁠
• Despliegue en PaaS mediante Docker: Docker PaaS⁠