- Linux or OSX
- Git: Version control
- PHP
- SQLite: Database
- Composer: PHP Package installer
- Node and npm: Build assets and some development features
- Docker: Centos 7 running Apache server container with the same configuration as the production environment
Follow each section below and run all the commands in the same order as listed.
$ mkdir <repo-dir>
$ git clone https://github.com/Pizzicato/CAFPE.git <repo-dir>
$ cd <repo-dir>
$ make init
When running make init, among other actions, the common git configuration values that all contributors should have in their .git/config folder are set. More specifically, those that enable the use of shared hooks which are located in the .githooks folder.
Since git version 2.9 the default hooks folder location can be changed using core.hookspath, allowing to share them among all contributors, and thus keeping commits more standard.
The only hook configured so far (pre-commit) regenerates documentation using apiGen when commiting the changes to the repo. This PHP package is installed in the next section.
To install the required PHP packages:
$ composer install
There is a Docker container with the same configuration and software version as the production environment. To use it:
$ docker pull pizzicato/centos7-apache-php54-sqlite3
$ docker run --name <name> -d -p 8020:80 -v <repo-dir>:/var/www/ pizzicato/centos7-apache-php54-sqlite3
Node and npm are used for this purpose. To install all needed modules:
$ npm install
The package.json file npm scripts are the same ones used for deploying the app used by deploy.bash. It contains two main scripts, run them in listed order to start developing:
Assets creation from sources (SCSS, javascripts, images and fonts)
$ npm run build
Automatic browse reload when assets change and automatic rebuild of assets if sources are changed:
$ npm run watch
To run tests:
$ vendor/bin/phpunit -c application/tests
$ composer update
Since 'kenjis/ci-phpunit-test' and 'kenjis/codeigniter-cli' packages use install scripts to copy files from vendor/ to application/, in case they are updated, they might have to be run again. This packages files are not gitignored since some of them have been edited manually. In case these packages are updated via composer, check all files that have been changed once copied, nad make all necessary changes to mantain the custom configuration.
If there is a new CodeIgniter package release, before pushing changes to repo, check if dependent packages have been updated accordingly.
Note that CodeIgniter base index.php file is in html/, and it's been been changed from the original source code for different reasons. In case this file is updated, it will have to be moved to the html/ folder manually, check changed lines and solve conflicts.
Chech the ApiGen autogenerated documentation here. As described above, it's regenerated automatically before every commit.