PAndemium
Descripción del problema
La idea viene motivada por conocer el número de contagios y posibles contagios de la mano de la población. Este problema trata de resolver o verificar si la información que nos proporcionan es real o no, haciendo de la colaboración ciudadana nuestra mejor arma.
Descripción del proyecto
Se creará una API REST que será la encargada de responder las peticiones y procesar los datos en formato JSON. Cualquier usuario podrá consultar el número de contagios confirmados en una fecha y provincia de España. Cada usuario tendrá un nick desde el cual podrá actualizar su estado.
Rúbricas 6
Justificación técnica del framework elegido para el microservicio y documentación de cómo se usa, diseño de la API y rutas.
Para el desarrollo del microservicio se han implementado el código y test siguiendo el diseño explicado y las historias de usuario:
- Para la resolución de HU3, consultar en un provincia y fecha los datos de contagios registrados se ha implementado el siguiente código y test
- Para la resolución de HU4, actualizar los datos del usuario (provincia, estado) y HU5, registrar un usuario y actualizar estado se ha implementado el siguiente código y test
- Para la resolución de HU6, consultar el número de contagios total de una Comunidad Autónoma (CCAA) se ha implementado el siguiente código y test
- Para la resolución de HU7, consultar si una Comunidad Autónama (ccaa) esta confinada se ha implementado el siguiente código y test
Para la configuración del gestor de tareas he utilizado grunt-shell para generar las tareas install y start ya que test ya estaba implementada. Y puesto que necesitaba que las tareas mandasen órdenes a una shell he necesitado utilizar el módulo grunt-shell mencionado. La tarea build se ha usado para eliminar la carpeta docs y Readme.md buscando que la imagen tenga lo necesario para funcionar, ya que node no necesita construir,generar... ejecutables.
Fichero Gruntfile.js
Se ha empezado a crear el Dockerfile para su futuro despliegue, donde hemos instalado lo necesario para el funcionamiento del gestor de tareas y subido el contenido de la carpeta ./src donde está contenida nuestra aplicación, para su posterior lanzamiento. Se ha utilizado el usuario sin privilegio creado por la imagen de node y se ha eliminado yarn, cache,.. siguiendo las buenas prácticas y buscando que la imagen sea lo más liviana posible.
Para el sistema de logs he buscado entre diferentes herramientas como:
- koa-logger
- bunyan-logger
- koa-logger-middleware
Eligiendo utilizar koa-logger-middleware, ya que es una versión mejorada de koa-logger, donde se permite la personalización de respuestas, como lo uso.
Historial de rúbricas
Enlaces internos
Accede al milestone que agrupa los issues.
- Clases implementadas, con las clases creadas.
- Test y clases de test
- Historias de Usuario.
- iv.yaml
- despliegue de aplicación sin docker.
- motivo elección herramientas
- GitPages
- Configuración git