Proyecto del curso de tdd

Plantilla para el curso de desarrollo para QA

Descripción del proyecto

Problema que queremos resolver: Nos ha interesado estudiar la evolución de una recuperación, estudiando para ello, cómo evoluciona la capacidad de recorrer una determinada ruta en días consecutivos.

Solución que proponemos: Utilizar la API de telegram y las funcionalidades que ofrece para recoger información de recorridos y procesarlas para mostrar información al usuario.

Herramientas que se usan en el proyecto

• Lenguaje: Python en el backend y JS en el frontend
• Librerias de python para telegram: python-telegram-bot
• Configuración remota: etcd
• Web server para la API: Flask
• Base de datos: Postgresql
• Frontend: Vue.js SPA hosteado en Github Pages. Tailwind como framework de CSS.
• Sistema de logging: LogDNA

Discutido en este issue

Estructura del proyecto

Hemos separado nuestro proyecto en dos carpetas siguiendo un estilo de monorepo.

• En la carpeta frontend hemos colocado todos los archivos relativos al frontend que por ahora es un archivo de js básico y un html con las librerías de js que necesitamos.

• En la carpeta src hemos colocado nuestro código del servidor donde tenemos el código de nuestro bot y el código de nuestra API. Además se incluye el módulo común para comunicarse con la abstracción en la base de datos y el archivo de dependencias del proyecto.

Miembros del equipo

• Yábir García @yabirgb
• Alejandro Alonso Membrilla @aalonso99
• Pilar Navarro Ramírez @pilarnavarro
• Juan José Herrera Aranda @KieDie

Instrucciones

Para instalar las dependencias del proyecto recomendamos la utilización de poetry. Una vez se tenga poetry instalado se ha de ejecutar

poetry install

para instalar las dependencias del proyecto. Para ejecutar los tests del proyecto basta con llamar a la herramienta poe de poetry bajo el comando 'test':

poetry run poe test

Desde dentro del entorno virtual generado por poetry es suficiente con:

poe test

Para ejecutar los tests de cobertura, análogamente, puede hacerse:

poetry run poe coverage

Para ejecutar la app del servidor debe ejecutarse:

poetry run poe run