Primeros pasos

Video de introducción: Instalación, descripción del gestor, el editor y la estructura del sistema, y vistazo general a las principales funciones.

También te recomendamos la guía en inglés, más concreta, estilo tutorial: https://github.com/gquagliano/foxtrot-framework-en/wiki/Installing-Foxtrot

¡Muy importante!

El gestor está pensado para uso personal en un servidor local, por lo que no presenta ningún tipo de seguridad. Implementar el directorio /gestor/ en un servidor público o compartido deja abierta la posibilidad de cargar código arbitrario.

Configurar el framework es muy sencillo.

1. Contar con un servidor local Apache con la última versión de PHP, o, como mínimo, 7.2+. Para utilizar Nginx, debe crearse la configuración equivalente al .htaccess (lo agregaremos a la brevedad).

2. Clonar el repositorio, o descargarlo y extraerlo, dentro del directiorio de archivos del servidor.

3. Construir el código fuente del framework ingresando en http://localhost/foxtrot-framework-master/construir/ (reemplazando localhost/foxtrot-framework-master por la URL del servidor).

   Luego de actualizar tu repositorio local (git pull), o tras realizar cambios en el código fuente del núcleo del framework (directorio /fuente/), debe repetirse este proceso.

   Nota: Esto solo es necesario ya que se está trabajando con el repositorio fuente de Foxtrot. Eventualmente, se realizarán lanzamientos de producción, con el núcleo del framework ya construído, y este paso será necesario solo para aquellos que deseen realizar modificaciones sobre el mismo.

4. Opcionalmente, configurar las credenciales predeterminadas de la base de datos, servidor SMTP y otras características en desarrollo/config.php (el asistente realizará la configuración mínima automáticamente).

Requerimientos

• PHP 7.2+

Para la construcción del framework y el gestor de aplicaciones:

• Para poder realizar la compilación (cuando no se usen los modos de depuración), Java (JRE) debe estar disponible en el Path y debe establecerse la variable de entorno JAVA_HOME.
• Tanto para poder realizar la compilación como para construir Cordova automáticamente desde el gestor, debe estar habilitada la función shell_exec(). Además, se recomiendan valores elevados de max_execution_time y max_input_time (0 no es ideal) o bien permitir al gestor establecer estos valores habilitando set_time_limit() e ini_set().

Notas:

• No es posible ejecutar Electron desde el gestor (ver detalles a continuación).
• Utilizando FCGI, los tiempos de ejecución de este pueden ser limitantes (ej. FcgidIOTimeout).
• Usualmente en instalaciones locales predeterminadas con FCGI, suele sobreescribirse el PATH desde la configuración de Apache.
• Las variables de entorno USERPROFILE (Windows), HOME (*nix), CORDOVA_HOME, ANDROID_SDK_ROOT y JAVA_HOME (JDK) deben estar establecidas.
• Utilizando FCGI, es probable que las variables de entorno deban establecerse en la configuración de Apache mediante FcgidInitialEnv.
• Luego de intentar la construcción o ejecución de la aplicación, el archivo desarrollo/exec.log puede servir para depurar problemas.

Acceso a la documentación

• PHPDOC
• JSDOC

Acceso al gestor de aplicaciones

Para ingresar al gestor de aplicaciones, acceder a http://localhost/foxtrot-framework-master/gestor/ (reemplazando localhost/foxtrot-framework-master por la URL del servidor de desarrollo).

Desde allí se podrá:

• Crear una aplicación en blanco
• Crear y editar vistas
• Crear controladores de servidor
• Crear y sincronizar el modelo de datos
• Ejecutar los asistentes
• Construir la aplicación para embeber (Cordova) o producción

Ver Gestor de aplicaciones y Editor de vistas para más información.

Crear una aplicación

Acceder al gestor de aplicaciones y utilizar el comando Nueva aplicación.

¿localhost ya está en uso? En un entorno de desarrollo, usualmente no tendremos un dominio distinto para cada aplicación. Lo ideal es crear dominios locales modificando el archivo hosts, o bien modificar el archivo config.php para que localhost apute a la aplicación en la que estamos trabajando.

Vista de inicio

La vista de inicio será inicio. Puede crearse con el comando Nueva vista del gestor.

Configurar la aplicación de ejemplo

1. Editar el archivo desarrollo/aplicaciones/ejemplo/config.php asignando los parámetros correctos de la base de datos, o removiéndolos si se desea tomarlos desde el archivo config.php global.

2. Instalar la base de datos de la aplicación de ejemplo mediante el comando Sincronizar modelo del gestor de aplicaciones.

Probar la aplicación

Ingresar a http://localhost/foxtrot-framework-master/desarrollo/ (reemplazando localhost/foxtrot-framework-master por la URL del servidor de desarrollo).

Compilación para producción

1. Utilizar el comando Construir para producción en el gestor.

2. Una vez construída la aplicación, puede publicarse el contenido del directorio produccion directamente en el servidor web.

Compilación para Cordova

1. Crear la aplicación mediante la línea de comandos de Cordova.

Ejemplo:

cd /ruta/
cordova create aplicacion
cordova platform add android

2. Utilizar el comando Construir embebible del gestor.

Si se desea construir Cordova manualmente, una vez completada la operación, el contenido del directorio embeber debe copiarse tal cual al directorio www de la aplicación y debe editarse el config.xml para que la página de inicio sea index-cordova.html.

Nota: Si se ha construido la aplicación previamente desde la línea de comandos o desde el IDE de Android, la construcción desde Foxtrot puede fallar. En ese caso, ejecutar cordova clean y desinstalar la aplicación en el dispositivo suele resolver el problema.

Integración con Electron

El gestor de aplicaciones puede encargarse de la construicción de la aplicación para Electron a través de Cordova, desde el comando Construir embebible. Sin embargo, si PHP se está ejecutando a través del servicio de Apache (lo más probable es que ese sea el caso), en Windows, no es posible ejecutar la interfaz de la aplicación.

En este caso, debe construirse la aplicación marcando la opción "Solo construir, no ejecutar" y luego ejecutarse desde la línea de comandos:

cordova run electron

Probar una vista para Cordova en el navegador web

El comando Ejecutar del listado de vistas del gestor iniciará la simulación de la vista Cordova en una nueva pestaña del navegador web.

Alternativamente, se puede acceder a http://localhost/foxtrot-framework-master/desarrollo/simular-cordova.php?vista=nombre_vista, (reemplazando localhost/foxtrot-framework-master por la URL del servidor de desarrollo) donde nombre_vista es el nombre de la vista que se desea ejecutar, sin extensión.

Nota: Probando vistas Cordova, normalmente tendrás que volver a ejecutarla, o volver a la vista inicial, para poder refrescar la página (refrescar con F5 puede no funcionar).