Saltar al contenido principal

Instalar el framework

Hay dos formas de tener Web Framework corriendo:

  • Instalación asistida por otra persona (recomendada si no eres técnico): pídele a quien te va a soportar el sistema que lo deje instalado; luego saltas directo a Primer inicio de sesión.
  • Instalación tú mismo: sigue esta guía. Necesitarás abrir una terminal alguna vez, pero está pensada para que no te pierdas.

¿Qué necesitas antes de empezar?​

Un computador (o un servidor) con:

  • Un servidor web: Apache (más fácil, viene con XAMPP o WAMP) o Nginx.
  • PHP versión 7.4 o superior.
  • Una base de datos MySQL o MariaDB.
  • Composer (gestor de dependencias de PHP).

:::tip ¿No sabes si tienes esto? Si nunca instalaste PHP: baja XAMPP (Windows/Mac/Linux). En una sola instalación te deja PHP, Apache y MySQL listos. Es la vía más rápida para probar el framework localmente. :::

Paso 1 — Descargar el framework​

Desde la terminal:

git clone https://github.com/Compuelec/web-framework.git
cd web-framework

Si no manejas git, también puedes descargar el ZIP desde GitHub y descomprimirlo.

Paso 2 — Instalar dependencias​

Todavía en la terminal, dentro de la carpeta del framework:

(cd api && composer install)
(cd cms/extensions && composer install)

Esto baja las librerías que el framework necesita para funcionar.

Paso 3 — Crear la base de datos​

Abre phpMyAdmin (viene con XAMPP en http://localhost/phpmyadmin) y crea una base de datos nueva. Puedes llamarla como quieras, por ejemplo web_framework.

No hace falta crear ninguna tabla dentro: el propio framework las va a crear después.

Paso 4 — Configurar las claves​

Copia los archivos de configuración de ejemplo:

cp api/config.example.php api/config.php
cp cms/config.example.php cms/config.php

Abre api/config.php con tu editor favorito y completa:

  • Nombre de la base de datos que creaste.
  • Usuario y contraseña de MySQL (en XAMPP suele ser root sin contraseña).
  • Deja los demás valores como vienen (API Key, JWT Secret, etc.) — el framework los usa internamente.

Abre cms/config.php y verifica que la URL de la API apunte a tu instalación local, por ejemplo:

'base_url' => 'http://localhost/web-framework/api',

:::warning Nunca subas config.php a Git Estos archivos contienen contraseñas. Ya están en .gitignore, así que no te preocupes por commitearlos por accidente. Los config.example.php sí van al repositorio. :::

Paso 5 — Instalador visual​

Abre en tu navegador:

http://localhost/web-framework/cms/

La primera vez verás una pantalla de instalador. Completa el formulario para crear el usuario administrador inicial — este será tu acceso al panel.

El instalador crea automáticamente todas las tablas que el framework necesita.

Paso 6 — Setup final​

De vuelta en la terminal, ejecuta:

sudo ./setup.sh

Este script:

  • Crea la configuración de la parte pública del sitio (web/config.php).
  • Ajusta permisos de las carpetas donde el framework guarda archivos subidos, páginas generadas y logs.

Es idempotente: puedes correrlo las veces que quieras, no rompe nada.

:::note ¿En Windows? Si estás en Windows, sudo ./setup.sh no aplica. En su lugar, asegúrate manualmente de que las carpetas cms/views/assets/files/, web/pages/, logs/, api/tmp/ y packages/ sean escribibles. :::

Verificar que quedó bien​

Abre nuevamente:

http://localhost/web-framework/cms/

Deberías ver la pantalla de inicio de sesión con el logo del framework. Si aparece: instalación exitosa.

¿Algo salió mal?​

  • Pantalla en blanco o error 500: mira el archivo logs/ para pistas. Suele ser un tema de permisos.
  • "No puedo conectar a la base de datos": revisa las credenciales en api/config.php.
  • 404 al entrar al CMS: asegúrate de que Apache tenga mod_rewrite habilitado.

Para casos concretos, revisa Errores comunes al instalar.

¿Qué sigue?​