Skip to content

Latest commit

 

History

History
84 lines (51 loc) · 3.25 KB

README.md

File metadata and controls

84 lines (51 loc) · 3.25 KB
Raw

GluePHP

Bienvenido a GluePHP, un framework para el desarrollo de aplicaciones web de una sola página empleando el paradigma de la programación dirigida por eventos.

Documentación

Requerimientos

  • PHP 7.1

Licencia

  • MIT

Instalación

Tenga en cuenta que el proyecto se encuentra en una fase inestable.

La instalación de GluePHP se realiza mediante composer. Para esto es necesario declarar las siguientes dependencias en el archivo composer.json.

{
    "require": {
        "glueapps/composed-views": "dev-0.1a",
        "glueapps/glue-php": "dev-0.1a"
    }
}

Seguidamente se debe ejecutar el comando:

$ composer update

Contribuyendo.

El desarrollo de GluePHP está basado en la metodología de desarrollo guiado por pruebas(TDD), por lo que cada funcionalidad del framework se encuentra cubierta por al menos una prueba. Para las pruebas al código PHP se emplea PHPUnit mientras que para el código JavaScript se emplea MochaJS, Chai y SinonJS. Para las pruebas a las funcionalidades full-stack se emplean las tecnologías PHPUnit, Selenium Server con Chrome Driver.

El código JavaScript está basado mayormente en ES5 con el objetivo de lograr compatibilidad con la mayoría de navegadores posibles, no obstante, también se han empleado algunas funcionalidades de ES6 pero que se encuentran ampliamente soportadas.

Para el código JavaScript existen algunas tareas automatizadas con GulpJS por lo que antes de hacer alguna modificación debe ejecutar el comando:

$ gulp

Pasos para contribuir en el proyecto.

  1. Hacer un fork de este repositorio.
  2. Clonar en local el nuevo repositorio que se ha creado en su cuenta de GitHub.
  3. Realizar las modificaciones con sus respectivas pruebas.
  4. Hacer push al origen.
  5. Crear un pull request.

Ejecutando las pruebas.

Una vez que ha clonado localmente el repositorio debe realizar la instalación de las siguientes aplicaciones:

1. Instale las dependencias de Composer.

$ composer update

2. Instale las dependencias de NPM.

$ npm update

3. Instale las dependencias de Bower

$ bower install

4. Ejecute el siguiente comando.

$ php -S localhost:8085

5. Ejecute Selenium Server.

$ java -jar <ruta_al_archivo>/selenium-server-standalone-x.x.x.jar

6. Ejecute PHPUnit.

$ php vendor/phpunit/phpunit/phpunit

Tenga en cuenta que algunos antivirus pueden hacen fallar ciertas pruebas por lo que puede ser necesario que añada alguna excepción al respecto.