aritaxi-validador-srv

Introducción

Servidor para la aplicación AriTaxi Validador que se encarga de notificar los servicios de taxi pendientes de validar por parte de los taxistas implicados. Los usuarios se identifican con un login y un password que permite conocer el taxista (sclien) del que se trate.

Parametrización

La aplicación se parametriza con un conjunto de variables de entorno que se pueden almacenar en un archivo .env

Parámetros implicados y su significado

• ARITXVAL_WINSTON_FILELEVEL Indica el nivel de log que se grabará en fichero (normalmente info).
• ARITXVAL_WINSTON_CONSOLELEVE Indica el nivel de log que se mosotrará por consola (normalmente info)
• ARITXVAL_PORT Indica el puerto por el que atenderá la api y en último termino la aplicación que de ella depende
• ARITXVAL_MYSQL_SERVER Dirección del host que aloja al servidor MYSQL en el que se encuentran guardados los datos.
• ARITXVAL_MYSQL_PORT Puerto MYSQL por el que atiende el servidor
• ARITXVAL_MYSQL_USER Usuario MYSQL
• ARITXVAL_MYSQL_PASSWORD Contraseña del usuario MYSQL
• ARITXVAL_MYSQL_DATABASE Base de datos MYSQL por defecto que usará la aplicación.
• ARITXVAL_SSL_USAR Indica si va a utilizar acceso https en local (S)
• ARITXVAL_SSL_PORT Si se usa SSL esta variable indica el puerto por el que se atenderán las llamadas https

Uso y compilación

aritaxi-validador-srv es una aplicación autocontenida esto quiere decir que en la misma aplicación tenemos la api y la aplicación web cliente servida desde el directorio www. Esta aplicación cliente está desarrollada en React y su fuente disponible en el repositorio (https://bitbucket.org/ariadnasw/aritaxi-validador-cli/src/main/)

Para poder modificar la parte de la aplicación cliente hay que generar su distibrución con el comando npm run build desde el directorio en el que se encuentre aritaxi-validador-cli y copiar el directorio generado /build en el directorio /src/www de la carpeta de api aritaxi-validador-srv

Uso

La aplicación está diseñada para usarse de dos maneras:

• Como un contenedor Docker desplegado en un servidor que soporte la opción
• Como un paquete npm que puede importar una aplicación nodejs

Como ejemplo de esta última opción se dispone de un fuente ad-hoc en el repositorio (https://bitbucket.org/ariadnasw/aritaxi-validador-inst/src/main/)

Compilación

Los dos tipos de uso dan lugar a dos tipos de compilaciones diferentes, lo importante es que según sea el caso deberemos modificar los ficheros package.json y tsup.config.ts

En el caso de la compilación como contenedor deberemos editar las propiedades del package.json con los siguientes valores.

"main": "./dist/server.js", "module": "./dist/server.mjs",

En el caso de cola compilación como paquete npm

"main": "./dist/app.js", "module": "./dist/app.mjs",

Para el fichero tsup.config.json en el caso de contenedor

entry: ["src/server.ts"]

Y en el caso de paquete npm.

entry: ["src/app.ts"]

Como se puede observar la diferencia estriba en cual será el punto de entrada que se usa en cada caso. Para los contenedores se usa server y en el caso de paquetes app

Generar paquete npm

Una vez realizadas las modificaciones a los ficheros indicadas en el paso anterior se ejecuta el comando npm run build que se encargará de generar el paquete de distribución adecuando. Cuando la generación haya finalizado se publicará el paquete con npm publish. Lógicamente deberemos habernos logeado en npm con el comando npm login y la cuenta [email protected]

Crear imagen de docker

El fichero Dockerfile ya contiene todos comandos necesarios para generar exitosamente la imagen. En el archivo comandos_docker.bat hay ejemplos para la generación de las imágenes y su publicación en Dockerhub