Core

Este es el servicio principal de Back-End de bookBnB. Contiene la lógica principal de negocio para la mayor parte de las funciones.

Ambientes

Se encuentra desplegado en un ambiente productivo y otro interno del equipo de desarrollo para testing:

• Producción con delívery continuo a partir de la rama master.
• Desarrollo con delívery continuo a partir de la rama develop.

Instalación

Dado que la aplicación se encuentra dockerizada la instalación es tan sencilla como:

$ git clone git@github.com:BookBnB/core.git

$ cd core

$ docker-compose up -d

Luego para conectarse a la app:

$ docker-compose exec app bash

Imagen

Para crear una imagen de docker con el estado actual de la aplicación se debe ejecutar:

$ docker/build_production_image.sh

Esto creará una imagen con el tag bookbnb:latest.

Despligue

Luego para desplegar la imagen en Heroku:

$ docker/heroku_push.sh

Es necesario que para ello se encuentre configurada la variable de ambiente $TRAVIS_BRANCH indicando la rama que se desea desplegar.

Build

Para compilar la aplicación:

$ npm run build # one time

$ npm run build:watch # fast recompile on file changes

Tests

Para ejecutar los tests:

$ npm run test # all tests, no coverage

$ npm run test:unit # unit tests only

$ npm run test:acceptance # acceptance tests only

$ npm run test:coverage # all tests, with coverage

Configuración

Se deben configurar las siguientes variables de ambiente:

variable	descripción
ALGOLIA_ADMIN_API_KEY	Api key de Algolia
ALGOLIA_APPLICATION_ID	Id de aplicación en Algolia
BACKOFFICE_URL	Url del front-end del backoffice
USERS_SERVICE_URL	Url del servicio de usuarios
DATABASE_URL	Url de conexión a la base de datos
NODE_ENV	Ambiente en el que se encuentra
SECRET_KEY	Clave random para generar tokens

Cobertura

El proyecto fue testeado con pruebas unitarias y de integración utilizando Gherkin logrando una cobertura mayor al 90%. Se puede ver el detalle de los reportes en codecov.

Arquitectura

Este microservicio utiliza una arquitectura hexagonal para mantener desacoplada la lógica de negocio con el resto de las conexiones del servicio.

OpenApi

Puede consultarse la especificación OpenApi en api.json o utilizando swagger en api-docs.