BioTablero

Front-End de BioTablero.

Este proyecto ha sido desarrollado por el Instituto Humboldt. El proyecto usa React.js.

1. Instrucciones

1.1. Prerequisitos

Debe tener instalado nodejs v22.12+

Clone el proyecto en su equipo e ingrese por línea de comandos al directorio del proyecto.

NVM

En caso usar nvm, puede activar la version necesaria con el siguiente comando:

nvm use

Si no tiene la versión correcta instalada, el comando le indicará como instalarla antes de poder usarla.

Active pnpm como el manejador de paquetes:

corepack enable

1.2. Instalación de paquetes

Ejecute la siguiente sentencia para instalar las dependencias del proyecto:

pnpm install

1.3. Configuración de variables de entorno

Crear una copia del archivo .env con el nombre .env.local actualizando los valores de las variables, de acuerdo a su entorno de desarollo.

• No olvide pedirle al admin los valores de las variables de entorno.

VITE_BACKEND_URL=''
VITE_GEOSERVER_URL=''
VITE_BACKEND_KEY=''
VITE_ENVIRONMENT='develop|staging|production'
VITE_API_KEY=''
VITE_DOMAIN=''
VITE_PROJECT_ID=''
VITE_STORAGE_BUCKET=''
VITE_SENDER_ID=''
VITE_APP_ID=''
VITE_SEARCH_BACKEND_URL=''
VITE_GA_TRACKING_ID=''
VITE_YM_ID=''
VITE_AUTH_BACKEND_URL=''

1.4. Ejecución

Por último, ejecute la siguiente instrucción:

pnpm dev

La instrucción iniciará el proyecto en su entorno local en el puerto 3000, para abrirlo puedes ir a http://localhost:3000, o, oprimir o + [Enter] en el terminal donde está corriendo Vite.

2. Despliegue con Docker

Para desplegar como contenedor de Docker es necesario contar la versión 17.05.0 o superior de Docker

2.1. Construcción de la imagen

Descargar el repositorio en el servidor donde se desplegará el servicio.

Tenga en cuenta la configuración de las variables de entorno: se deberá crear una copia del archivo .env con el nombre .env.production.local, y actualizar los valores de las variables, de acuerdo a su entorno de despliegue.

Ejecutar la siguiente instrucción para construir la imagen:

docker build -t biotablero-front:<version> .

Es recomendable usar como versión de la imagen el valor del release actual en GitHub.

2.2. Despliegue del servicio

Una vez esté creada la imagen, se despliega de la siguiente manera:

docker run -d  -p <puerto host>:5000 --name <nombre contenedor> biotablero-front:<version imagen>

3. Utilitarios

Verificar reglas de estilo

Ejecutar la siguiente linea para verificar los estilos del proyecto:

pnpm check-format

Ejecuta la siguiente linea para formatear los archivos del proyecto

pnpm format

Para verificar que el codigo siga las guias de estilo

pnpm lint

Para corregir automaticamente el codigo según la guía de estilo (cuando sea posible)

pnpm fix-lint

---

Autores

Gerencia de Información Científica - Dirección de conocimiento - Instituto de Investigación de Recursos Biológicos Alexander von Humboldt - Colombia

• Erika Suárez - Erikasv
• Camilo Zapata - cazapatamar
• Manuel Galvez - ManuelStardust