StyleMind - Backend

Ver repositorio del frontend

Descripción del Proyecto

Esta aplicación backend es desarrollada con NestJS para la gestión del armario personal de un usuario. Permite a los usuarios añadir, eliminar y modificar prendas de ropa. La funcionalidad principal reside en la generación de conjuntos de ropa personalizados mediante el uso de inteligencia artificial generativa, ofreciendo sugerencias de combinaciones basadas en las prendas disponibles.

Objetivos

• Proporcionar una API robusta y escalable para la gestión de prendas de ropa.
• Implementar un sistema de recomendación de conjuntos de ropa inteligente y personalizado.
• Integrar con servicios externos para el almacenamiento de imágenes y la generación de contenido con IA.
• Ofrecer una experiencia de usuario fluida y eficiente a través de la API.

Guía de Instalación y Despliegue

Esta sección detalla los pasos necesarios para instalar y desplegar el backend de SyleMind.

Prerrequisitos

Antes de comenzar, asegúrate de tener instalado lo siguiente:

• Node.js: (Versión recomendada: 22 o superior)
• yarn (de preferencia) o npm (Viene con Node.js)
• Docker: (Opcional, para despliegue con contenedores)
• Docker Compose: (Opcional, para despliegue con contenedores)

Servicios Dependientes

El backend de SyleMind depende de los siguientes servicios:

• PostgreSQL: Base de datos relacional para almacenar la información de las prendas, usuarios y conjuntos.
• Redis: Base de datos en memoria para el almacenamiento en caché y la gestión de sesiones.
• Firebase Storage: Servicio de almacenamiento de objetos para las imágenes de las prendas.
• Servicio de IA Generativa: para la generación de conjuntos de ropa.

Variables de Entorno

El backend requiere las siguientes variables de entorno para funcionar correctamente. Puedes definirlas en un archivo .env en la raíz del proyecto.

NODE_ENV=development
PORT=3000

# PostgreSQL
DATABASE_URL= postgres://tu_usuario_postgres:tu_contraseña_postgres@tu_host_postgres:tu_puerto_postgres/tu_base_de_datos

# Redis
REDIS_HOST=tu_host_redis
REDIS_PORT=6379
REDIS_PASSWORD=tu_contraseña_redis (si la tienes)
REDIS_USERNAME=(si es necesario)
REDIS_SSL=true|false (dependiendo de si se requiere SSL)

# Selección de almacenamiento
STORAGE_PROVIDER=MINIO|FIREBASE

# Firebase (opcional si en OBJECT_STORAGE se selecciona MINIO)
FIREBASE_PROJECT_ID=tu_proyecto_id
FIREBASE_API_KEY=tu_api_key_firebase
FIREBASE_BUCKET_NAME=tu-bucket-name
FIREBASE_MESSAGING_SENDER_ID=tu_sender_id
FIREBASE_APP_ID=tu_app_id

# MinIO (opcional si en OBJECT_STORAGE se selecciona FIREBASE)
MINIO_ENDPOINT=tu_endpoint_minio
MINIO_PORT=tu_puerto_minio
MINIO_ACCESS_KEY=tu_access_key_minio
MINIO_SECRET_KEY=tu_secret_key_minio
MINIO_USE_SSL=true|false
MINIO_BUCKET=tu_bucket_minio

# Servicio de IA Generativa
AI_PROVIDER=google|ollama|openai|lmstudio
#GOOGLE_GENERATIVE_AI_API_KEY=tu_api_key_google
#OPENAI_API_KEY=tu_api_key_openai

# Modelo de IA
TEXT_MODEL=modelo_de_texto

# Url de la API de IA Generativa ollama|lmstudio (opcional)
AI_URL=http://localhost:8080/generate

Importante:

• Reemplaza los valores de ejemplo con tus propias credenciales.
• De acuerdo a lo que necesites, puedes elegir entre MinIO o Firebase para el almacenamiento de objetos. No es necesario definir las variables de entorno de ambos servicios.
• Los modelos se pueden obtener desde la página oficial de Vercel AI SDK

Instalación

1. Clonar el repositorio:

   git clone https://github.com/codecbros/StyleMind_Backend.git
   cd SyleMind-Backend

2. Instalar las dependencias:

   yarn install  # o npm install

3. Configurar las variables de entorno:

   Crea un archivo .env en la raíz del proyecto y completa las variables de entorno como se describe en la sección anterior.

4. Ejecutar las migraciones de la base de datos:

   yarn prisma migrate deploy  # o npm run prisma migration production

Despliegue

Aquí se describen algunas opciones para desplegar el backend de SyleMind.

1. Despliegue Local (Desarrollo)

yarn run start:dev  # o yarn dev

Esto iniciará el servidor en modo de desarrollo con recarga automática.

2. Despliegue con Docker

1. Construir la imagen de Docker:

   docker build -t SyleMind-backend .

2. Ejecutar el contenedor Docker:

   docker run -d -p 3000:3000 \
     -e NODE_ENV=production \
       -e PORT=3000 \
       -e DATABASE_URL=postgres://tu_usuario_postgres:tu_contraseña_postgres@tu_host_postgres:tu_puerto_postgres/tu_base_de_datos \
       -e REDIS_HOST=tu_host_redis \
       -e REDIS_PORT=6379 \
       -e REDIS_PASSWORD=tu_contraseña_redis \
       -e REDIS_USERNAME=tu_usuario_redis \
       -e REDIS_SSL=true|false \
       -e FIREBASE_PROJECT_ID=tu_proyecto_id \
       -e FIREBASE_API_KEY=tu_api_key_firebase \
       -e FIREBASE_BUCKET_NAME=tu-bucket-name \
       -e FIREBASE_MESSAGING_SENDER_ID=tu_sender_id \
       -e FIREBASE_APP_ID=tu_app_id \
       -e GOOGLE_GENERATIVE_AI_API_KEY=tu_api_key_google \

   Importante:

   • Reemplaza los valores con tus propias credenciales.
   • Considera usar un archivo .env y la opción --env-file de Docker para gestionar las variables de entorno.

3. Despliegue con Docker Compose

1. Crear el archivo docker-compose.yml:

2. Ejecutar Docker Compose:

   docker-compose up -d

   Asegúrate de tener las variables de entorno definidas en un archivo .env en la misma carpeta que el docker-compose.yml.

Contribución

Si deseas contribuir al proyecto, por favor, sigue estas pautas:

1. Crea un fork del repositorio.
2. Crea una rama para tu funcionalidad o corrección de errores.
3. Realiza tus cambios y asegúrate de que pasen todas las pruebas.
4. Envía una solicitud de extracción (Pull Request) con una descripción clara de tus cambios.

Desarrollo mediante dev container

Para facilitar el desarrollo, puedes utilizar un contenedor de desarrollo (dev container) que incluye todas las herramientas necesarias. Asegúrate de tener instalado Visual Studio Code y la extensión Remote - Containers.

Licencia

Gpl-3.0