https://github.com/cristopher1/app_colmena_abeja

Aplicación desarrollado durante el proceso de trabajo de titulo
https://github.com/cristopher1/app_colmena_abeja

Last synced: about 1 year ago
JSON representation

Aplicación desarrollado durante el proceso de trabajo de titulo

• Host: GitHub
• URL: https://github.com/cristopher1/app_colmena_abeja
• Owner: cristopher1
• Created: 2023-07-14T11:31:41.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-02T17:19:25.000Z (over 2 years ago)
• Last Synced: 2025-01-28T02:41:56.030Z (over 1 year ago)
• Size: 93.8 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# [APP COLMENA ABEJA](#indice)

El presente proyecto fue desarrollado durante el ramo **trabajo de titulo**, para optar al titulo de **ingeniero civil informático** en la Universidad Técnica

Federico Santa María (UTFSM). Este sistema busca detectar la presencia o ausencia de abeja reina dentro de una colmena, mediante la extracción de características

de los zumbidos emitidos por ella, los cuales serán procesados por una red neuronal convolucional (CNN), para finalmente indicar si existe la presencia de abeja

reina dentro de dicha colmena.

### Índice

* [Introducción](#Introducción)

*  [Prerrequisitos](#Prerrequisitos)

*  [Descargar el repositorio](#Descargar-el-repositorio)

* [Variables de entorno](#Variables-de-entorno)

  * [Para el FRONTEND](#Para-el-FRONTEND)

  * [Para la API](#Para-la-API)

* [Ejecutar la aplicación](#Ejecutar-la-aplicación)

##  [Introducción](#introduccion)

El presente repositorio tiene como finalidad almacenar las herramientas que permiten automzatizar el despliegue del sistema. El sistema se divide en un frontend 

y una API (almacenadas en repositorios independientes) y unidas en un tercer repositorio (este repositorio) mediante git-submodule. Este repositorio además de

juntar los dos repositorios independientes, también contiene un archivo docker-compose.yml y .env.example (utilizado para generar el archivo .env) que permitirán

ejecutar el sistema de forma automática.

##  [Prerrequisitos](#prerrequisitos)

El sistema ha sido probado en SO Windows 11.

* Docker Desktop con Servidor WSL 2. Ver documentación sobre [Docker Desktop para Windows](https://docs.docker.com/desktop/install/windows-install/)

##  [Descargar el repositorio](#descarga)

Para descargar el repositorio use:

```console

git clone --recurse-submodules git@github.com:cristopher1/app_colmena_abeja.git

```

##  [Variables de entorno](#entorno)

La información de las variables de entorno se encuentra dentro del archivo .env.example, este archivo tiene 8 variables, que son usadas dentro del archivo

docker-compose.yml para establecer la forma en que se va a desplegar el sistema. A continuación se muestra su estructura.

https://github.com/cristopher1/app_colmena_abeja/blob/9bb1a74002ca747bb5d142e7fb5a44329cb35d2c/docker-compose.yml#L1-L21

A continuación se muestran las variables de entorno usadas en el archivo docker-compose.yml presentado anteriormente.

###  [Para el FRONTEND](#entorno-frontend)

https://github.com/cristopher1/app_colmena_abeja/blob/23bea7412bc6b070c52e0b026cf7102eb3c47060/.env.example#L7-L22

* `FRONTEND_PROJECT_DIRECTORY`: Nombre de la carpeta que contiene el FRONTEND y en su raíz esta el

archivo Dockerfile. Debería llamarse **frontend_app_colmena_abeja**

* `FRONTEND_STAGE`: Modo en el que se desplegará el FRONTEND. development o production

* `FRONTEND_HOST_PORT`: Puerto en el HOST, donde el FRONTEND escucha peticiones

* `FRONTEND_CONTAINER_PORT`: Puerto en el contenedor, donde el FRONTEND escucha peticiones

###  [Para la API](#entorno-api)

https://github.com/cristopher1/app_colmena_abeja/blob/23bea7412bc6b070c52e0b026cf7102eb3c47060/.env.example#L24-L39

* `API_PROJECT_DIRECTORY`: Nombre de la carpeta que contiene la API y en su raíz esta el

archivo Dockerfile. Debería llamarse **api_colmena_abeja**

* `API_STAGE`: Modo en el que se desplegará la API. development o production

* `API_HOST_PORT`: Puerto en el HOST, donde la API escucha peticiones

* `API_CONTAINER_PORT`: Puerto en el contenedor, donde la API escucha peticiones

##  [Ejecutar la aplicación](#run)

Para ejecutar la aplicación siga los siguientes pasos.

* **Nota: Los archivos Dockerfile presentes en el repositorio api_colmena_abeja y frontend_app_colmena_abeja utilizan**

**Multi-stage, por lo que no debe olvidar habilitar el docker BuildKit al momento de ejecutar la aplicación.**

* **Nota: A partir de la versión 23.0 de Docker Desktop y Docker Engine se usa de forma predeterminada el BuildKit**

**por lo que no es necesario habilitarlo de forma manual.**

1. Ingrese a la carpeta app_colmena_abeja (desde la terminal o interfaz gráfica)

2. Cree un archivo llamado .env (en la misma carpeta donde esta el archivo .env.example)  

3. Copie el contenido del archivo .env.example a .env

4. Si gusta, modifique los valores del archivo .env

5. Repita el paso 2, 3 y 4 en api_colmena_abeja y frontend_app_colmena_abeja

6. Abra una terminal e ingrese a la carpeta app_colmena_abeja

7. Ejecute el comando `docker-compose up --build`

**Nota: En modo producción no exponga directamente el contenedor api_colmena_abeja, en su lugar use un servidor de producción como nginx para redirigir**

**las peticiones web al contenedor api_colmena_abeja.**

Una vez completados los pasos, el sistema debería estar ejecutandose en `http://localhost:${FROTEND_HOST_PORT}`