🧠 MindCare API Documentation

🎯 Nuestra Misión

Democratizar el acceso al seguimiento emocional con rigor clínico.

MindCare nace de una realidad preocupante: millones de personas enfrentan síntomas depresivos sin acceso a recursos profesionales debido a barreras económicas, geográficas o estigma social.

Nuestra plataforma combina fundamentos clínicos basados en el DSM-5 y técnicas de Behavioral Activation con tecnología moderna y accesible, ofreciendo herramientas de autogestión emocional respaldadas por evidencia científica.

No reemplazamos la terapia profesional — somos el puente que acompaña a quienes necesitan apoyo mientras buscan ayuda especializada.

📑 Índice

• Características Principales
• Stack Tecnológico
• Instalación
• Observabilidad y Monitoreo
• Arquitectura
• Documentación
• Capturas de Pantalla
• Despliegue en Producción
• CI/CD Pipeline
• Cumplimiento Normativo
• Equipo de Desarrollo

✨ Características Principales

Aplicación desplegada

MindCare está completamente dockerizada y lista para despliegue en producción con CI/CD automatizado.

Despliegue Local con Docker

# Clonar repositorio
git clone https://github.com/AdrianDiaz24/DAW2-Proyecto-Grupo-7.git
cd DAW2-Proyecto-Grupo-7

# Configurar variables de entorno
cp .env.docker.example .env

# Levantar todos los servicios (Frontend, Backend, MongoDB)
docker-compose up -d

# Acceder a la aplicación
# Frontend: http://localhost:3000
# Backend API: http://localhost:5000/api

Imágenes Docker Disponibles

Las imágenes de Docker están publicadas en Docker Hub y actualizadas automáticamente con CI/CD:

• Backend: dockerhub-username/mindcare-backend:latest
• Frontend: dockerhub-username/mindcare-frontend:latest

URL de Producción

URL de producción: https://mindcare.com

Nota: La aplicación está desplegada tanto en Render como Vercel usando las imágenes Docker generadas automáticamente por GitHub Actions.

Desplegar tu Propia Instancia

Documentación completa de despliegue: docs/despliegue.md

El documento de despliegue incluye:

• Arquitectura de despliegue con diagramas
• Configuración de Docker y Docker Compose
• Pipeline CI/CD con GitHub Actions
• Guía paso a paso para Render
• Variables de entorno y configuraciones
• Troubleshooting y resolución de problemas
• Buenas prácticas implementadas

Despliegue en Render (Recomendado):

• ✅ Tier gratuito con 750h/mes
• ✅ HTTPS automático
• ✅ Deploy automático desde Docker Hub
• ✅ MongoDB Atlas incluido
• ✅ URL pública accesible

Ver guía paso a paso detallada: docs/despliegue.md

CI/CD Automatizado

El proyecto incluye GitHub Actions workflows que automatizan:

✅ Build y Push a Docker Hub - Cada push a main o dev construye y publica nuevas imágenes versionadas automáticamente
✅ Generación de Documentación JSDoc - Documentación del código generada automáticamente y desplegada en GitHub Pages
✅ Generación de PDFs - Documentación en formato PDF disponible en artifacts de GitHub Actions
✅ Deploy a GitHub Pages - Documentación técnica accesible públicamente en https://adriandiaz24.github.io/DAW2-Proyecto-Grupo-7/

Workflows disponibles:

• docker-build.yml - Construcción y publicación de imágenes Docker
• docs-build.yml - Generación y despliegue de documentación JSDoc

Ver workflows en: .github/workflows/

🛠️ Stack Tecnológico

Frontend

Backend

AI & Analytics

DevOps & Infrastructure

📊 Observabilidad y Monitoreo

MindCare implementa un sistema de observabilidad para garantizar la fiabilidad del servicio en producción.

Health Check Endpoint

GET /api/health

{
  "status": "ok",
  "message": "API is up and running",
  "timestamp": "2026-02-13T10:00:00.000Z"
}

Logging Estructurado

El sistema utiliza Morgan para logging de requests HTTP:

GET /api/auth/profile 200 15.234 ms - 256
POST /api/registro 201 45.123 ms - 512
GET /api/diario 200 23.456 ms - 1024

Docker Health Checks

Los contenedores incluyen verificación automática de estado:

healthcheck:
  test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:4000/api/health"]
  interval: 30s
  timeout: 10s
  retries: 3
  start_period: 40s

Métricas Recomendadas para Producción

🏗️ Arquitectura

┌─────────────────────────────────────────────────────────────────┐
│                         CLIENTE                                  │
│                    (React + Zustand)                            │
└─────────────────────────────┬───────────────────────────────────┘
                              │ HTTPS
                              ▼
┌─────────────────────────────────────────────────────────────────┐
│                    NGINX (Reverse Proxy)                         │
│               SSL Termination + Static Files                     │
└─────────────────────────────┬───────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────────┐
│                      EXPRESS SERVER                              │
│  ┌─────────────────────────────────────────────────────────┐   │
│  │                   MIDDLEWARE STACK                       │   │
│  │  Helmet → CORS → Morgan → JSON Parser → Cookie Parser   │   │
│  └─────────────────────────────────────────────────────────┘   │
│                              │                                   │
│  ┌───────────────────────────┼───────────────────────────────┐ │
│  │                      ROUTES                               │ │
│  │  /auth  /diario  /registro  /formulario  /contactos  /ai │ │
│  └───────────────────────────┼───────────────────────────────┘ │
│                              │                                   │
│  ┌───────────────────────────┼───────────────────────────────┐ │
│  │              AUTH MIDDLEWARE (JWT)                        │ │
│  └───────────────────────────┼───────────────────────────────┘ │
│                              │                                   │
│  ┌───────────────────────────┼───────────────────────────────┐ │
│  │                   CONTROLLERS                             │ │
│  └───────────────────────────┼───────────────────────────────┘ │
└──────────────────────────────┼──────────────────────────────────┘
                               │
              ┌────────────────┼────────────────┐
              ▼                ▼                ▼
┌─────────────────┐  ┌─────────────────┐  ┌─────────────────┐
│    MONGODB      │  │    GROK AI      │  │     SMTP        │
│   (Mongoose)    │  │  (OpenRoute)    │  │  (Nodemailer)   │
└─────────────────┘  └─────────────────┘  └─────────────────┘

Modelos de Datos

🚀 Instalación

🐳 The Fast Way (Docker Compose)

Ideal para: Demos, testing de integración, evaluación rápida

# 1. Clonar el repositorio
git clone https://github.com/AdrianDiaz24/DAW2-Proyecto-Grupo-7.git
cd DAW2-Proyecto-Grupo-7

# 2. Configurar variables de entorno
cp .env.docker.example .env
# Editar .env con tus credenciales de MongoDB Atlas

# 3. Levantar toda la infraestructura
docker-compose up -d

# 4. Verificar servicios
docker-compose ps

# 5. ¡Listo!
# Frontend: http://localhost:3000
# Backend:  http://localhost:4000/api
# Health:   http://localhost:4000/api/health

# Detener servicios
docker-compose down

🛠️ The Developer Way (Setup Manual)

Ideal para: Desarrollo activo, debugging, contribuciones al código

Prerrequisitos

• Node.js 18.x+ (Descargar)
• MongoDB 7.x local o MongoDB Atlas
• npm o yarn

Backend Setup

cd backend
npm install

Crear archivo .env:

# Server
PORT=4000
NODE_ENV=development

# Database
MONGODB_URI=mongodb://localhost:27017/mindcare

# Auth
JWT_SECRET=tu_clave_secreta_muy_segura_de_32_caracteres
JWT_EXPIRES_IN=1h

# CORS
FRONTEND_URL=http://localhost:3000

# Email (Sistema de Emergencia)
EMAIL_USER=tu_email@gmail.com
EMAIL_PASS=tu_app_password

# AI (Opcional)
OPENROUTE_API_KEY=tu_api_key

npm run dev
# ✅ Backend corriendo en http://localhost:4000

Frontend Setup

cd frontend
npm install

Crear archivo .env:

REACT_APP_API_URL=http://localhost:4000

⚠️ Importante: REACT_APP_API_URL debe apuntar a la URL base sin /api

npm start
# ✅ Frontend corriendo en http://localhost:3000

Verificar Instalación

# Health check del backend
curl http://localhost:4000/api/health
# Respuesta: {"status":"ok","message":"API is up and running",...}

📚 Documentación

📊 Documentation Roadmap

📋 Business & Planning

🔧 Technical Deep-Dive

📅 Sprint Documentation

🔗 Recursos Externos

📥 PDFs: Disponibles en Actions → Artifacts del repositorio.

🚢 Despliegue en Producción

URL de Producción

🌐 https://mindcare-frontend.onrender.com

Imágenes Docker

Las imágenes se publican automáticamente con cada push a main:

# Backend
docker pull [dockerhub-username]/mindcare-backend:latest

# Frontend  
docker pull [dockerhub-username]/mindcare-frontend:latest

Desplegar tu Propia Instancia

Opción recomendada: Render.com

• ✅ Tier gratuito (750h/mes)
• ✅ HTTPS automático
• ✅ Deploy desde Docker Hub
• ✅ Variables de entorno seguras

📖 Guía completa: docs/despliegue.md

🔄 CI/CD Pipeline

┌─────────────┐     ┌─────────────┐     ┌─────────────┐     ┌─────────────┐
│   Commit    │────▶│   GitHub    │────▶│   Docker    │────▶│   Render    │
│   to main   │     │   Actions   │     │    Hub      │     │   Deploy    │
└─────────────┘     └─────────────┘     └─────────────┘     └─────────────┘
                           │
                           ├──▶ Build & Test
                           ├──▶ Docker Build & Push
                           ├──▶ JSDoc Generation
                           └──▶ GitHub Pages Deploy

Workflows Activos

📁 Ver configuración: .github/workflows/

⚖️ Cumplimiento Normativo

MindCare está diseñado para cumplir con las normativas de protección de datos aplicables en España y la Unión Europea.

Medidas Técnicas Implementadas

• ✅ Consentimiento explícito en registro (checkbox obligatorio)
• ✅ Derecho al olvido - Eliminación completa de datos de usuario
• ✅ Portabilidad - Exportación de datos en formato legible
• ✅ Encriptación - Contraseñas con bcrypt, conexiones HTTPS
• ✅ Minimización de datos - Solo se recopilan datos necesarios

📖 Documentación completa: docs/legislacion.md

👥 Equipo de Desarrollo

MindCare ha sido desarrollado por un equipo de estudiantes de DAW2 comprometidos con crear tecnología de impacto social positivo.

📄 Licencia

Este proyecto está licenciado bajo la MIT License - ver el archivo LICENSE para más detalles.