A standard PHP project skeleton

Versión en español

This project was created in order to provide project skeleton to start new PHP project.

• Requirements
• Create project
• Composer scripts
• TODO
• Contribute
• License

Requirements

This project is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Create project

You'll need Composer.

composer create-project josantonius/php-skeleton {project-path}

What is the vendor name ?

(MyVendor): Josantonius

What is the package name ?

(MyPackage): AwesomeProject

What is the package prefix ?

():

What is the version ?

(1.0.0):

What is your name ?

(Josantonius):

What is your email ?

([email protected]):

Various config files are ready for continuous integration.

* phpunit.xml.dist for phpunit * phpmd.xml for PHPMD * phpcs.xml for PHP_CodeSniffer * .php_cs for php-cs-fixer * .travis.yml for Travis CI

Composer scripts

tests

composer tests run phpcs, phpmd and phpunit. Run phpunit for unit test only.

composer tests

fix

composer fix run php-cs-fixer and phpcbf to fix up the PHP code to follow the coding standards.

composer fix

? TODO

• [ ] Improve documentation

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

• Fork and clone.
• Run the command `composer install` to install the dependencies. This will also install the dev dependencies.
• Run the command `composer fix` to excute code standard fixers.
• Run the tests.
• Create a branch, commit, push and send me a pull request.

License

This project is licensed under MIT license. See the LICENSE file for more info.