dhii/bootstrap

Bootstraps a new Dhii project.

Bootstrap

, _(*1)

A bootstrap tool for quickly creating standard Dhii packages., _(*2)

Phing is used to build your project files, based on project information provided during the bootstrapping phase, either through command line prompts or arguments., _(*3)

• Composer package info file
• CS Fixer configuration file
• PHPUnit configuration file
• Convenient composer scripts for testing and fixing code standards
• Travis configuration file
• CodeClimate configuration file
• Netbeans Project Info
• License file
• Changelog file
• Readme file
• Functional and unit test templates
• Git repository info

Usage

Step 1. Cloning

Via Composer

Use composer's built-in create-project command, as follows:, _(*4)

composer create-project dhii/bootstrap my-project

This will create the my-project directory and download the bootstrap files., _(*5)

Via PHPStorm

Go to File, then New Project. On the left-hand side, under PHP-Specific, choose Composer Project., _(*6)

Enter the location of the project, including the name of the project as a directory name. For example: some/path/my-project., _(*7)

Under package, search for dhii/bootstrap, select the search result and click Create., _(*8)

PHPStorm will download the bootstrap files and automatically install its dependencies., _(*9)

Step 2. Bootstrapping

From the newly created project directory simply invoke Phing, which should be installed locally to the project., _(*10)

cd my-project
vendor/bin/phing

This will run in interactive mode, which will prompt you to enter information about the project. Information regarding the prompts can be found below., _(*11)

Quiet Mode

You can invoke the bootstrapping process in quiet mode via the -Dquiet=true argument. This will make the script run silently without prompts but also requires you to pass the values of the prompts as command arguments, prefixed with -D. For example:, _(*12)

vendor/bin/phing -Dquiet=true -Dcomposer.vendor=dhii -Dcomposer.name=my-project -Dorganization="Dhii Team"...

Properties

For more information about these properties, take a peek inside the [build.xml] file., _(*13)

Known Issues

• Due to a [Composer bug][1] it is currently not possible to automatically invoke phing after project creation.