Configuración de ambiente de desarrollo - Solify-IT/psyche-ing GitHub Wiki
Configuración de ambiente de desarrollo
Framework
Para el framework que se va a utilizar, es necesario instalar las siguientes librerías:
Nota: Debe asegurarse que al instalarse, los ejecutables o archivos binarios de los anteriores estén dentro de las variables de entorno o el PATH del sistema operativo
Una vez que se instaló lo anterior, deberá instalar Yarn. Yarn es una herramienta de gestión de dependencias de paquetes de JavaScript. Para este proyecto se utilizara Yarn.
Ya que se instaló Yarn, podrá clonar el repositorio y tanto en backend como en frontend podrá hacer
yarn install
dentro de la carpeta backend y frontend para poder así instalar todas las dependencias.
Variables de entorno
Para manejar las variables de entorno tanto en frontend como backend que pueden cambiar dependiendo de donde se esta corriendo (Ejemplo: Dirección IP del backend) se utilizara archivos de configuración de entorno .env.
En la raíz de cada proyecto (backend y frontend) se deberá crear un archivo llamado .env que debe incluir por lo menos lo siguiente:
Backend
DB_NAME=<tu_host_de_db>
DB_USER=<tu_usuario_de_db>
DB_PASS=<tu_contrasenia_de_db>
Frontend
De lado de frontend, es necesario que todas las variables de entorno empiecen con 'REACT_APP_' para que react registre estas variables exitosamente.
REACT_APP_API_URL=<ip_de_backend>
Linting
Para la verificacion del cumpliemiento del estandar de codificación para así tener mejor calidad, se utilizara la herramienta de linting ESlint para verificar que se esté cumpliendo con los estándares dados. Para este proyecto, se utilizará la guía de estilo de Airbnb:
Esta dependencia ya está dentro de la configuración del proyecto dentro del archivo .eslintrc.js. Si desea ajustar alguna de las reglas de estilo o la configuración general del linting se puede hacer en ese mismo archivo.
Para ejecutar el linting manualmente, puede correr el comando:
yarn lint
Sin embargo, se recomienda tener una herramienta en el editor de texto o en el IDE para correr esto de forma automática al agregar y editar código.
Dependencias
Las dependencias y sus versiones pueden cambiar durante el transcurso del proyecto. Si desea ver que dependencias tiene el proyecto o agregar alguna nueva, esta información se puede encontrar en el archivo package.json.
Si desea agregar una nueva dependencia al proyecto, esto se puede hacer con el comando yarn add
Herramientas recomendadas
Como editor de texto se recomienda utilizar Visual Studio Code junto con las siguientes extensiones: