jpchateau/prototype-php-library

A PHP library

PHP Library Prototype

PHP Library Prototype is a tool to quickly initiate the development of a new PHP library., _(*1)

Features

The aim of this prototype is to save time when starting to develop a PHP library. It will: * Download and install basic files - a class and its test class with proper namespaces * Install popular QA tools: phpunit, phpstan and phpcs * Generate basic .gitignore and README files, _(*2)

Please note that .gitignore file is based upon gitignore.io API., _(*3)

Requirements

• PHP >= 7.3
• php-xml extension
• php-mbstring extension
• Composer

Check the PHP roadmap to see the PHP versions supported by this library., _(*4)

Usage

Creating a library is a simple two-step process.
1. First, create a project from this prototype. Replace MyDirectory with your own value to create the project and move into the created directory:, _(*5)

$ composer create-project jpchateau/prototype-php-library MyDirectory && cd $_

1. Then, run the install command to complete the process. Replace MyCompany and MyProject with your own values:

$ make company=MyCompany project=MyProject install

You are ready to develop!
Don't forget to pick up a license ;), _(*6)

Tests

$ make tests

QA Tools

$ bin/phpcs src/ --standard=PSR2
$ bin/phpstan analyse -l 7 src/