Template inicial para inicio rápido de una PWA

Instalación rápida

• Ejecuta: composer install
• Esto instala dependencias y genera autoload en vendor/autoload.php

Primer inicio del repositorio

• Ejecuta: composer setup
• Luego valida: composer qa
• Guía rápida: docs/README_INICIO.md

Entornos (dev/staging/prod)

• 1. Crea el archivo base del proyecto:
  • Copia .env.example a .env.
• 2. Crea el archivo del ambiente que vas a ejecutar:
  • Desarrollo local: .env.dev
  • Preproducción: .env.staging
  • Producción: .env.prod
• 3. Define APP_ENV en el servidor con uno de estos valores: dev, staging, prod.
• 4. Completa variables clave en cada ambiente:
  • APP_DEBUG, APP_TIMEZONE
  • SESSION_DOMAIN, SESSION_SECURE, SESSION_SAMESITE
  • MAIL_HOST, MAIL_PORT, MAIL_USERNAME, MAIL_PASSWORD, MAIL_ENCRYPTION, MAIL_FROM_ADDRESS, MAIL_FROM_NAME
• 5. Reinicia Apache/PHP-FPM después de cambiar archivos de entorno.
• Prioridad de carga en runtime:
  • Primero se carga .env (base).
  • Luego se carga .env.{APP_ENV} (sobrescribe valores del base).
• Valor por defecto:
  • Si no existe APP_ENV, la aplicación usa dev.

Documentación

• Índice general: docs/README.md
• Inicio rápido (onboarding): docs/README_INICIO.md
• Composer: docs/README_COMPOSER.md
• Calidad (lint/tests/análisis): docs/README_CALIDAD.md
• CI/CD (quality workflow): docs/README_CI.md
• Operación (logs/backups): docs/README_OPERACION.md
• Estado del proyecto (checklist): docs/README_CHECKLIST.md
• Seguridad app (CSRF/rate-limit): docs/README_SEGURIDAD_APP.md
• Base de datos (migrations/seeders): docs/README_DB.md
• Mail (PHPMailer): docs/README_MAIL.md
• PDF (FPDF): docs/README_PDF.md
• Arranque y rutas: docs/README_RUTAS.md
• Integración con n8n: README_WEBHOOKSERVICE.md

Contribución

• Flujo de colaboración: docs/CONTRIBUTING.md

Estructura sugerida (correo y PDF)

• Correo (PHPMailer): /app/componentes/mailer/
• PDF (FPDF): /app/componentes/pdf/
• Controladores que consumen estos servicios: /app/controllers/
• Configuración SMTP: /app/config/ (variables por entorno, sin claves hardcodeadas)

Componentes

• Ruta base: /app/componentes/
• Ejemplos:
  • /app/componentes/alerts (incluido)
  • /app/componentes/logger (incluido)
  • /app/componentes/paymentsimulator (no incluido)