If you currently live in Russia, please read this message.
Php Project is a simple starting point for your next PHP project! Forked from thephpleague/skeleton, it not only provides boilerplate for commonly needed package files, but can populate placeholders with your own project details.
You can get started by using Composer's create-project command.
composer create-project webtheory/php-project project-nameOn Unix/Linux systems, you should automatically be prompted for your project information after installation. If not, or if installing on Windows, manually run the prefill interactive script in the console from your project root directory by entering:
php prefillYou'll then be asked a few questions that will allow Php Project to personalize the boilerplate with your info, initiate a new git repository, and update composer's autoload with your project's unique namespace.
Some commonly defined directories have been included and are merely suggestive. Delete what you don't need and rename and restructure as you wish.
assets/
bench/
bin/
build/
config/
docs/
logs/
public/
spec/
src/
story/
templates/
tests/
vendor/
views/
Php Project gets you started with an assortment of third-party tools that are useful for development and testing. Some of these will be redundant and you'll want to choose some over others. Simply delete any you don't need from the require-dev section of your composer.json and they'll be uninstalled the next time you run the composer update command. Information and documentation for each can be found at their websites linked below.
Much of the included boilerplate is for CI and test automation services. All that's required of you is to register your project's repository with your preferred services and you're good to go. Check them out at:
Php Project provides extra composer commands via composer scripts. These of course are simply mapped to the cli of some of the various development utilities included.
If you find that you often make projects with a specific or more defined structure, you can simply fork "Php Project" and make your own additions. The prefill process is easily extended and the script itself can be modified to perform unique tasks. There are even simple task runners (testprefill and testproject) located in the bin directory that you can use to easily check that your customizations are functioning properly and showing up as expected.
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.