Transferr API V1.1

Este proyecto está desarrollado en Node.JS y el Framework LoopBack

Requisitos

Estos son loas requisitos con los que debes contar para trabajar en la API

Software	Link
Loopback cli	npm install -g @loopback/cli
Node js	16.13.0 LTS Descarga

1.-Implementación de la base datos

• Descargar la Semilla Demo
• Crear base datos con el nombre “transferr_db”
• Hacer la importación de la semilla descargada a la base datos.
• Listo con ese último paso terminamos con la base de datos.

Nota: Si causa problemas la semilla puede que no sea la version mas resiente.

2. Implementacion de la API

La API está implementada con el framework de loopback 4, estos son los comandos para poder iniciar el proyecto:

Primer paso:
Este comando se utiliza ejecutar el proyecto y también se encarga de hacer actualizaciones a la base de datos (si es que es necesario)
En este paso se instalarán todas las dependencias

npm install

nota: Si es la primera vez que se ejecuta se recomienda hacer un compilado previeo

npm run build

Segundo paso:
Hay que crear un archivo .env en la raiz del proyecto con la siguientes variables:

DB_PORT=3306
DB_USER="root"
DB_PASSWORD="password"
DB_DATABASE="transferr_db_2"
DB_HOST="localhost"

Tercer paso:
En este paso el comando a mostrar se encarga de levantar el proyecto(si hay cambios en los modelos con alteraciones en las propiedades estas se verán afectadas en la base datos).

npm start

Si en la terminal te muestra el siguiente mensaje quiere decir que todo salió de forma correcta.

Server is running at http://[::1]:3001
Try http://[::1]:3001/ping

Nota: Si ya hay una base datos creada pueden suceder varios problemas con FK.

• Que Marque el problema de que las llaves no son compatibles. Solucion revisar la colacion de la columna que marca el problema y ver que coincidan.
• Que Marque que la tabla no existe. Este problema puede suceder dado que intenta crear una FK de una tabla que aun no se crea. Solucion crear esa tabla de forma manual o ejecutar el comando de migracion(se mostrara mas adelante)

Migraciones

Las migraciones en la API hay dos tipos, la primera es a un nivel de modificación simple como un cambio a nivel columna o alguna nueva relación.

La migración automática esta se ejecuta cada que inicia el proyecto con el comando

npm start

El otro tipo de migración va de la mano del comando

npm run migrate

Por último la migración para restablecer la base de datos desde 0 (no se recomienda usar)

npm run migrate -- --rebuild

3.Extras

La API tiene integraciones con librerías de terceros una de ellas es un servidor de rutas open source, si es necesario utilizarlo para el entorno de desarrollo solo hagan la petición al encargado para que lo encienda.

Inegración de github actions