Backend para TPO de Desarrollo de Aplicaciones I 🚀

• Integrantes
• Introducción
• Requisitos
• Descargar la aplicación e instalar dependencias
• Crear archivo de variables de entorno
• Ejecutar la app
  • Por Terminal
  • Por Docker Compose
    • Start Containers
    • Stop Containers
• Healthcheck
• Uso del backend
  • Listado de endpoints

Integrantes

• Canevaro, Tomas
• Maidana, Emmanuel
• Patricio, Matias
• Quatraro, Nicolás

Introducción

Esta API está destinada para ser el backend de la aplicación mobile de la empresa MyHome

Requisitos

• NodeJS
• Poseer una MONGODB_URI válida para comunicarse con la base de datos
• Opcional: Docker Compose

Backend

Esta app corre el backend, para integrarse con el frontend. A continuación se detalla cómo instalar las dependencias y correr la aplicación.

Descargar la aplicación e instalar dependencias

git clone git@github.com:enuelx/myhome-backend.git myhome-backend
cd myhome-backend
npm install

Crear archivo de variables de entorno

cp .env.example .env
cd ..

Agregar los datos que faltan dentro del .env

Ejecutar la app

Por Terminal

npm start

Por Docker Compose

Start Containers

docker-compose up --build -d

Stop Containers

docker-compose down

Healthcheck

Sin chequeo de dependencias

Para el caso de que la API se encuentre levantada sin verificar dependencias:

Con chequeo de dependencias

Para el caso de que la API se encuentre funcionando con las dependencias funcionando correctamente:

Uso de la API

Ahora el backend está listo para usar.

Se pueden probar los endpoints a través de Swagger. La misma se encuentra levantada en la ruta "api/v1/docs", por ejemplo, si el backend se encuentra en el puerto 3000, la ruta es: http://localhost:3000/api/v1/docs

Listado de endpoints de swagger