Instalación
El framework se puede instalar en cualquier servidor con Apache2 y PHP 8.0 (al utilizar anotaciones como sistema de enrutado, PHP 8.0.0 es la versión mínima necesaria para que funcione).
MySQL no es necesario, pero en caso de querer usarlo el requisito es que sea de la versión 5.1 o superior. También se puede usar MariaDB 10.1 o superior, Postgresql, SQLite... Al utilizar PDO para la conexión solo depende de que los drivers apropiados estén instalados.
Para realizar la instalación hay dos formas:
Osumi Framework CLI
A partir de la versión 7.8.0 hay una nueva herramienta llamada Osumi Framework CLI.
Primero hay que descargar el ejecutable del CLI y ejecutar el siguiente comando:
ofw new <nombre>
Esto descargará el repositorio en una carpeta llamada <nombre>, y a continuación limpiará todo el código de ejemplo.
Instalación mediante git
Ejecutando el siguiente comando se puede obtener una copia completa:
git clone https://github.com/igorosabel/Osumi-Framework.git
Esto creará una carpeta llamada Osumi-Framework en el directorio en el que se haya ejecutado el comando.
Descargar el código en zip
Pulsando en el siguiente enlace se puede bajar un archivo zip con todo el contenido del repositorio desde Github:
Al pulsar, se descargará un archivo llamado Osumi-Framework-master.zip con el contenido del repositorio.
Extractor
El framework dispone de una herramienta llamada Extractor que permite exportar todo el contenido de una aplicación a un solo archivo PHP que luego se puede copiar o llevar donde sea necesario.
Por ejemplo para mover una aplicación de un sitio a otro, hacer una copia de seguridad...
Primero hay que descargar el archivo zip que contiene este archivo PHP desde Github:
Dentro de este archivo zip hay un archivo llamado ofw_extractor.php
Ejecutando el siguiente comando se extrae todo el contenido de este archivo Extractor:
php ofw_extractor.php
Creador
Creador es una aplicación que permite mediante una interfaz web diseñar y configurar una aplicación desde cero.
En esta aplicación se puede diseñar toda la configuración del sitio, los modelos de base de datos, librerías que se pueden añadir a la parte frontal (AngularJS, jQuery, Bootstrap...) y finalmente se puede generar un archivo ZIP que se puede descargar.
El Creador deja los apartados del código vacíos para empezar a programar.
El código de esta aplicación también se encuentra en GitHub con licencia MIT:
- Aplicación web (front): https://github.com/igorosabel/Creador
- API de la aplicación (backend): https://github.com/igorosabel/ApiCreador
Instalación
Una vez se dispone de todo el código hay que realizar los siguientes pasos:
Junto con el Framework se incluye código de ejemplo para una simple aplicación de fotos: un listado de usuarios y el detalle de un usuario. También se incluye un ejemplo de llamada AJAX para la creación de una API.
Borrar todo el código de ejemplo es sencillo, hay que borrar todo el contenido de las siguientes carpetas (el contenido, no las carpetas):
app/componentapp/filterapp/modelapp/moduleapp/serviceapp/taskofw/export- Todos los archivos en
webexcepto el archivo.htaccessy el archivoindex.php
Una vez borrado todo el código de ejemplo se puede empezar el proceso de creación de una nueva aplicación.
El archivo app/config/config.json contiene la configuración del sitio, se explica más detalladamente en Configuración.
En caso de querer usar https, hay que editar el archivo web/.htaccess para configurar la redirección. Las líneas 14 y 15 son las que hacen la redirección forzada a https:
RewriteCond %{SERVER_PORT} 80
RewriteRule ^(.*)$ https://demo.osumi.es/$1 [R,L]
En caso de no querer usar https, basta con comentar estas dos líneas. Recomiendo encarecidamente usar https con Let's Encrypt
Con esto la aplicación estaría lista para empezar a ser programada.
A continuación se explica la estructura de las carpetas que componen el framework: Estructura