2017 © Pedro Peláez
 

library skeleton

Generic PHP project skeleton package

image

php/skeleton

Generic PHP project skeleton package

  • Tuesday, July 17, 2018
  • by koriym
  • Repository
  • 14 Watchers
  • 110 Stars
  • 1,097 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 21 Forks
  • 0 Open issues
  • 37 Versions
  • 0 % Grown

The README.md

A standard PHP project skeleton

Are you tired of copy-pasting your boilerplate PHP code whenever you need to start a new project?, (*1)

This repository contains a single-line command that will automatically setup for you all the needed code to create a modern, clutter-free and test-oriented PHP package., (*2)

It will automatically install the following dependencies:, (*3)

  • PHPUnit: provides testing framework.
  • PHP_CodeSniffer: detects violations of a defined set of coding standards.
  • PHPMD: analyze your code to detect sub-optimal or overly complex code.
  • PHPStan: discover bugs in your code without running it.
  • Psalm: - another static analysis tool from Vimeo.
  • PHPMetrics provides various metrics.
  • ComposerRequireChecker Check composer dependencies.

Project Structure

After installation, your project will have the following structure:, (*4)

your-project/
├── src/                 # Source code
├── tests/               # Test files
│   └── Fake/            # Test doubles
├── vendor/              # Dependencies
├── vendor-bin/          # Development tool dependencies
├── build/               # Build artifacts (coverage reports, etc.)
├── composer.json        # Project configuration
├── phpcs.xml            # PHP_CodeSniffer configuration
├── phpmd.xml            # PHPMD configuration
├── phpstan.neon         # PHPStan configuration
├── phpunit.xml.dist     # PHPUnit configuration
├── psalm.xml            # Psalm configuration
├── composer-require-checker.json  # Composer dependencies checker configuration
└── README.md            # Project documentation

Create Project

To create your project, enter the following command in your console:, (*5)

composer create-project koriym/php-skeleton <project-path>

You will be asked a few questions to configure the project:, (*6)

What is the vendor name ?
(MyVendor):Koriym

What is the package name ?
(MyPackage):AwesomePackage

What is your name ?
(Akihito Koriyama):

What is your email address ?
(akihito.koriyama@gmail.com):

Composer Commands

Once installed, the project will automatically be configured, so you can run these commands in the root of your application:, (*7)

test

composer test runs phpunit., (*8)

tests

composer tests runs cs, sa, and test., (*9)

coverage, phpdbg, pcov

composer coverage builds a test coverage report using XDebug. composer phpdbg builds a test coverage report using phpdbg. composer pcov builds a test coverage report using pcov., (*10)

cs, cs-fix

composer cs checks coding standard. composer cs-fix fixes the PHP code to match coding standards., (*11)

sa

composer sa runs static code analysis tools (PHPStan and Psalm)., (*12)

metrics

composer metrics generates code quality metrics., (*13)

build

composer build builds all reports (code quality, test coverage, require check, metrics)., (*14)

Continuous Integration

This project includes several GitHub Actions workflows to ensure code quality and compatibility. These workflows are pre-configured for common PHP project needs, but feel free to modify or remove them to suit your project's requirements., (*15)

The Versions

17/07 2018

1.x-dev

1.9999999.9999999.9999999-dev https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=7.0.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

17/07 2018

1.0.2

1.0.2.0 https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=7.0.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

24/04 2018

1.0.1

1.0.1.0 https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=7.0.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

24/04 2018

dev-spike

dev-spike https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=7.0.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

23/04 2018

1.0.0

1.0.0.0 https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=7.0.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

23/04 2018

1.0.x-dev

1.0.9999999.9999999-dev https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=7.0.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

13/04 2018

1.0.0-alpha

1.0.0.0-alpha https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=7.0.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

04/04 2018

0.9.0

0.9.0.0 https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=7.0.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

03/06 2017

0.8.5

0.8.5.0 https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=5.6.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

16/05 2017

0.8.4

0.8.4.0 https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=5.6.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

22/03 2017

dev-php7

dev-php7

Skeleton application for BEAR.Sunday

  Sources   Download

MIT

The Requires

 

The Development Requires

28/02 2017

0.8.3

0.8.3.0 https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php >=5.6.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

06/02 2017

0.8.1

0.8.1.0 https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php ^5.6 || ^7.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

12/12 2016

0.8.0

0.8.0.0 https://github.com/koriym/Koriym.PhpSkeleton

Generic PHP project skeleton package

  Sources   Download

MIT

The Requires

  • php ~5.6|~7.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

05/08 2016

0.7.5

0.7.5.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

MIT

The Requires

  • php ~5.6|~7.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

29/07 2016

0.7.4

0.7.4.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

17/04 2016

0.7.3

0.7.3.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

05/03 2016

0.7.2

0.7.2.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

05/03 2016

0.7.1

0.7.1.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

05/03 2016

0.7.0

0.7.0.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Akihito Koriyama

psr skeleton

21/12 2015

0.6.2

0.6.2.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

MIT

by Akihito Koriyama

psr skeleton

22/09 2015

0.6.1

0.6.1.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

MIT

by Akihito Koriyama

psr skeleton

23/05 2015

0.5.1

0.5.1.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

23/05 2015

0.5.0

0.5.0.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

17/02 2015

0.4.2

0.4.2.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

03/02 2015

0.4.1

0.4.1.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

02/02 2015

0.4.0

0.4.0.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

20/05 2014

0.3.2

0.3.2.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

12/05 2014

0.3.1

0.3.1.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

24/03 2014

0.3.0

0.3.0.0

  Sources   Download

proprietary

06/11 2013

0.2.4

0.2.4.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

15/09 2013

0.2.3

0.2.3.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

13/09 2013

0.2.2

0.2.2.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

04/09 2013

0.2.1

0.2.1.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

29/08 2013

0.2.0

0.2.0.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

20/08 2013

0.1.1

0.1.1.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton

23/04 2013

0.1.0

0.1.0.0 https://github.com/koriym/PHP.Skeleton

Generic PHP.Skeleton package

  Sources   Download

BSD-3-Clause

by Akihito Koriyama

psr skeleton