Saltar a contenido

⚙️ Instalación del entorno local

Este documento describe los pasos necesarios para instalar y poner en marcha el entorno local de desarrollo de CORDIA.

Asegúrate de haber cumplido con los requisitos previos descritos en la sección "Requisitos y dependencias".

1. 🔁 Clonar el repositorio

# Clona el proyecto principal
git clone git@github.com:cordia-astur/cordia-backend.git
cd cordia-backend

Si no tienes acceso, solicita una clave SSH al equipo técnico.

2. 🐳 Levantar los contenedores con Docker

# Levantar TODOS los servicios (recomendado)
./run.sh dev --rebuild

# O solo el backend Laravel
./run-service.sh dev apilaravel --rebuild

La primera vez puede tardar unos minutos.

2.1. 🌐 Configurar /etc/hosts (dominios locales)

Para acceder por nombre de dominio en el entorno local, añade estas entradas a tu /etc/hosts:

127.0.0.1 cordia.local                # Raíz Laravel (health/redirect)
127.0.0.1 api.cordia.local           # API (Laravel)
127.0.0.1 panel.cordia.local         # Admin (Filament)
127.0.0.1 admin.cordia.local         # Panel de gestión (Vue)
127.0.0.1 grafana.cordia.local       # Dashboards (Grafana)
127.0.0.1 status.cordia.local        # Monitorización (Uptime Kuma)
127.0.0.1 adminer.cordia.local       # Admin DB (Adminer)
127.0.0.1 swagger.cordia.local       # Visor API (Swagger UI)
127.0.0.1 apidocs.cordia.local       # Documentación de la API Laravel (Scribe)
127.0.0.1 docs.cordia.local          # Documentación de usuario (MkDocs)
127.0.0.1 devdocs.cordia.local       # Documentación técnica (MkDocs)
127.0.0.1 reports.cordia.local       # Informes HTML generados automáticamente sobre el estado del proyecto
127.0.0.1 npm.cordia.local           # Nginx Proxy Manager
127.0.0.1 schema.cordia.local        # Visor de esquema DB (SchemaSpy)

En sistemas Unix, necesitas permisos de administrador para editar /etc/hosts.

3. 🛠 Preparar el entorno de Laravel

# Instalar dependencias PHP (dentro del contenedor)
docker compose exec apilaravel composer install

# Generar clave de la app
docker compose exec apilaravel php artisan key:generate

# Ejecutar migraciones + seeders (entorno dev)
docker compose exec -e SEED_ENV=dev apilaravel php artisan migrate:fresh --seed

4. 🌐 Acceso a la plataforma

Una vez levantado el entorno, puedes acceder a:

Si no puedes acceder, revisa el archivo /etc/hosts y añade las entradas necesarias (ver sección "Configurar /etc/hosts").

5. 🧪 Ejecutar tests

./scripts/tests-run-and-report.sh

Para más detalles sobre dominios, servicios, y configuración avanzada, consulta las secciones correspondientes de la documentación técnica.