adalsa91 / vedetra-server

GNU General Public License v3.0
0 stars 0 forks source link

Vedetra Server

Build Status codecov

Este proyecto forma parte del Trabajo de Fin de Grado Sistema de bajo coste para detección de dispositivos WiFi y Bluetooth que se puede consultar en el siguiente repositorio: https://github.com/adalsa91/tfg

Sistema para recolección y consulta de detecciones de dispositivos WiFi y BLE mediante API REST, también dispone de una interfaz web para visualizar los datos. El sistema consta de dos servicios: el servidor web desarrollado con Flask y un servicio de base de datos (PostgreSQL).

INSTRUCCIONES

La instrucciones detalladas de la instalación se puede encontrar el fichero INSTALL.md, para un despligue rápido consultar la sección Instalación rápida

Instalación rápida

Prerrequisitos

Seguir las instrucciones oficiales para instalar Docker y Docker Compose.

Docker

Docker Compose

Variables de entorno

Las variables de entorno se pasan a los contenedores a través de los ficheros especificados en la directiva env_file de los ficheros docker-compose*.yml. Se puede consultar las variables a definir en los ejemplos web.env.sample y db.env.sample.

Clonar el repositorio.

git clone https://github.com/adalsa91/vedetra-server.git
cd vedetra-server

Crear imágenes.

docker-compose build

Arrancar entorno de desarrollo.

docker-compose -f "docker-compose.yml" -f "docker-compose-dev.yml" up

El entorno de desarrollo crea un volumen en el contenedor enlazado a tu copia local de la aplicación para poder hacer modificaciones sin necesidad de volver a crear la imagen.

:warning: Warning No usar docker-compose-dev.yml en producción.

Tests

Para lanzar los tests unitarios ejecutar los siguientes comandos:

docker-compose run --name db -d db
docker-compose run vedetra flask test