Información adicional sobre la buildtool
Como buildool se ha elegido gulp, una herramienta de
construcción sencilla de utilizar y muy potente. Para obtener
más información sobre esta, se recomienda visitar la página principal.
Para este proyecto, la buildtool se ha utilizado para facilitar los procesos de testing, generación de la documentación, obtención de cobertura de los tests e inicialización, reinicio y parada del microservicio mediante el gestor de tareas PM2. Para más información sobre éste, consulta esta parte de la documentación.
¿Cómo usar la buildtool con el proyecto?
Para usar gulp con este proyecto, tenemos que situarnos en el
nivel raíz del directorio donde está clonado el proyecto, donde está
definido el archivo gulpfile.js con las tareas de gulp. Este archivo
con las tareas puede ser consultado aquí.
Las tareas que soporta son las siguientes:
gulp test: Ejecuta los tests que se encuentran entest/.gulp coveralls: Se tiene que ejecutar después degulp test, y permite obtener cobertura del código.gulp start-node: Inicia el microservicio utilizandonode.gulp start: Inicia el microservicio utilizando PM2.gulp restart: Reinicia el microservicio, matando el proceso que se está ejecutando e iniciandolo de nuevo. Para ello utiliza PM2.gulp reload: Reinicia el microservicio sin matarlo mediante PM2. Es más eficiente quegulp restart.gulp stop: Para el microservicio mediante PM2.gulp doc: Genera la documentación de los archivos fuentes encontrados en el directoriosrc/, donde está tanto la clase de gestión como la API REST, entre otros. Para generarla, hace uso de JSDoc y apiDoc.gulp heroku: Permite reproducir la secuencia de pasos para realizar el despliegue en Heroku.gulp heroku-docker: Permite reproducir la secuencia de pasos para realizar el despliegue en Heroku utilizando el Dockerfile presente en el proyecto.gulp docker-build: Permite construir la imagen de Docker utilizando el Dockerfile presente en el proyecto.gulp docker-run: Permite ejecutar la imagen de Docker creada.