ramsey/php-library-skeleton

A tool to quickly set up the base files of a PHP library package.

Fund package maintenance!
ramsey

Installs: 252

Dependents: 0

Suggesters: 0

Security: 0

Stars: 72

Watchers: 6

Forks: 16

Open Issues: 0

Type:project

2.1.4 2020-05-29 18:34 UTC

This package is auto-updated.

Last update: 2020-11-10 00:52:41 UTC


README

A tool to quickly set up the base files of a PHP library package.

Source Code Download Package PHP Programming Language Build Status Codecov Code Coverage Psalm Type Coverage Read License Package downloads on Packagist Chat with the maintainers

About

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. You may use the project directory that's created 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.

Usage

Running the command below will create a new repository containing the same files and structure as this skeleton repository. Afterward, it will run the Ramsey\Skeleton\Setup::wizard() callable to set up the project, which will walk you through a series of questions and make changes to files based on your answers. When complete, it will remove the ./src/Skeleton and ./tests/Skeleton directories, leaving everything else in place with an initial commit.

composer create-project ramsey/php-library-skeleton YOUR-PROJECT-NAME

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.

FAQs

Why did you include package/tool x and not y?

I created this project skeleton generator for my own uses, and these are the common files, packages, and tools 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!

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.