josantonius/php-skeleton

Generic PHP project skeleton package

1.0.1 2018-01-07 13:39 UTC

README

Latest Stable Version Latest Unstable Version License Total Downloads PSR2 PSR4

Versión en español

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

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}

asciicast

Various config files are ready for continuous integration.

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.

Copyright

2017 - 2018 Josantonius, josantonius.com

If you find it useful, let me know 😉

You can contact me on Twitter or through my email.