¿Qué aprenderá?

Al finalizar este tutorial el estudiante estará en capacidad de usar el API REST que se provee como base para el desarrollo del proyecto del curso.

¿Qué obtendrá?

Las herramientas necesarias para el uso del API REST.

¿Qué necesita?

Es necesario que tenga:

1. Manejo básico de GitHub.
2. Manejo de consola de comandos.

Para ejecutar el back tiene dos opciones: usar Docker o instalar las herramientas en su equipo local. A continuación se explican los pasos para cada alternativa.

Teniendo Docker previamente instalado en su equipo, clone el repositorio del proyecto:

git clone git@github.com:MISW-4104-Web/BackArte7.git

Ingrese a la carpeta BackArte7 y ejecute el siguiente comando:

docker-compose up --build

Con esto se crearán dos contenedores, uno en donde estará ejecutándose el backend y otro donde estará ejecutándose la base de datos.

Para comprobar que todo esté bien vaya a la sección final de este documento denominada Probar las colecciones. .

Para ejecutar el back en su equipo local, instale las herramientas que se mencionan en la Tabla 1. Las versiones indicadas son las usadas al momento de realizar este tutorial. Si usa otras versiones es posible que deba resolver problemas de compatibilidad.

Tabla 1. Herramientas necesarias para ejecutar el back

Configurar la base de datos

Una vez instalada la base de datos, inicie el programa pgAdmin que viene incluido en la instalación de PostgreSQL. Esto abrirá una nueva pestaña en el navegador por defecto con la dirección http://127.0.0.1:57193

En la parte izquierda de la pantalla despliegue la opción Servers > PostgreSQL > Databases (ver Figura 2).

Figura 2. Vista principal de pgAdmin.

Haga clic derecho sobre el nodo Databases y seleccione la opción Create > Database y cree una nueva base de datos con el nombre arte7.

Clonar el repositorio

Desde la línea de comandos clone el repositorio que contiene el código de back:

git clone git@github.com:MISW-4104-Web/BackArte7.git

Ejecutar el proyecto

Ingrese a la carpeta del proyecto y edite el archivo src/app.module.ts. Verifique que los valores para "username" y "password" corresponden con los de su instalación de postgres.

Luego, desde la línea de comandos ingrese a la carpeta donde clonó el repositorio e instale las dependencias con el comando:

npm install

Luego ejecute:

npm run start

Esto iniciará un servidor web que escucha peticiones en el puerto 3000.

Para probar las colecciones y verificar que el backend se está ejecutando correctamente debe abrir Postman e importar las colecciones que se encuentran en el directorio donde se clonó el back, en la carpeta collections.

Luego en la sección Environments de Postman importe el environment denominado collections/EntornoArte7.postman_environment.json. En este ambiente está configurado el valor de la variable {{baseUrl}} que será usado por Postman para la ejecución de las colecciones. Revise que el valor de la variable sea http://localhost:3000/api/v1

Seleccione una colección y ejecútela.

Si todo quedó configurado correctamente, la ejecución será satisfactoria.