A tool to quickly set up the base files of a PHP library project.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
app
skeleton
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
composer.json
phpstan.neon
phpunit.xml.dist

README.md

ramsey/php-library-skeleton

Source Code Latest Version Software License PHP Version Build Status Coverage Status Total Downloads

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.

Installation

ramsey/php-library-skeleton is not a library that you install in the traditional way using 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 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 directory, git init, and off you go!

Why did you include x and not y?

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!

Contributing

While this project is mostly for my own needs, contributions are welcome. Please read CONTRIBUTING for details.

Copyright and License

The ramsey/php-library-skeleton library is copyright © Ben Ramsey and licensed for use under the MIT License (MIT). Please see LICENSE for more information.