A tool to quickly set up the base files of a PHP library package.
ramsey/php-library-skeleton is a package that may be used to generate a basic PHP library project directory structure, complete with many of the starting files (i.e. README, LICENSE, GitHub issue templates, PHPUnit configuration, etc.) that are commonly found in PHP libraries. The project directory that's created may be used as a starting point for creating your own PHP libraries.
This project adheres to a Contributor Code of Conduct. By participating in this project and its community, you are expected to uphold this code.
ramsey/php-library-skeleton is not a library that you install in the traditional
composer require. Instead, you'll use
composer create-project to
use this package as a starting part for developing your own PHP library.
Here's how do this, using Composer:
composer create-project --remove-vcs ramsey/php-library-skeleton target-directory
You will be walked through a series of questions, and your PHP library source
files will be located in
target-directory, when completed. Change to that
git init, and off you go!
Simply put: I created this project skeleton generator for my own uses, and these are the common files and boilerplate language I use in my PHP libraries. If you like what you see, feel free to use it. If you like some of it but not all, fork it and customize it to fit your needs. I hope you find it helpful!
While this project is mostly for my own needs, contributions are welcome. Please read CONTRIBUTING for details.