Marketplace de Clases Particulares 🚀

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

Integrantes

• Gordo, Juan Martin
• Haedo, Joaquin Hector
• Maidana, Emmanuel Carlos Leonel

Introducción

Aplicación de un marketplace de clases particulares, proyecto integrador de la materia Aplicaciones Interactivas de UADE - Turno Viernes Noche - 2022.

Arquitectura

Requisitos

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

Backend & Frontend

Esta app corre el frontend y backend como dos módulos separados en paralelo. A continuación se detalla cómo instalar las dependencias y correr la aplicación.

Descargar la aplicación e instalar dependencias

git clone [email protected]:enuelx/marketplace-profesores-particulares.git marketplace
cd marketplace && cd api
npm install
cd ../frontend
npm install
cd ..

Crear archivo de ambiente

cd api
cp .env.example .env
cd ..

Agregar los datos que faltan dentro del .env

Ejecutar la app

Por Terminal

cd api
npm start &
cd .. && cd frontend
npm start &

Por Docker Compose

Start Containers

docker-compose up --build -d

Stop Containers

docker-compose down

Healthcheck

Backend

Frontend

Uso del backend

Ahora tanto el backend como el frontend están listos para usar.

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

Listado de endpoints from swagger