fairfieldstaticmailer
About
URL: https://github.com/darith27/fairfieldstaticmailer
Author: darith27
Build dependencies
In order to build your generated Composer project from its source, you will need Grunt and PHP on the command line.
So, you must install PHP5 on your system on your command line. Test it:
php --help
To install Grunt globally on the command line (and run the above build task), run:
npm install -g grunt-cli
Then, with Grunt, you can install Composer, PhpDocumentor, PhpUnit and PhpCPD locally. Just run once:
grunt init
Then, you can install PhpDocumentor, PhpUnit and PhpCPD locally. Just run once:
php composer.phar install -v
Finally, you should also install the PHP extension named Xdebug, which will be used by PhpUnit for code coverage.
Build the sources
Once all your dependencies are installed, you can build your project with Grunt:
grunt build
The build process will run the following tasks:
- PhpLint: runs php -l over the "src" folder
- Runs the tests located in the "tests" folder with PHPUnit
- Generates a PhpDocumentor documentation in the "doc" folder from the files of the "src" folder
- Detects copy/paste of code in the files of the "src" folder with PhpCPD
Credits
fairfieldstaticmailer was initiated with generator-composer, a Yeoman generator that builds a PHP Composer project.
This project uses the following as development dependencies: