jncampbell / scaffolder
A terminal command to generate php package boilerplate
Installs: 33
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Type:command-line-tool
Requires
- symfony/console: ^3.0
This package is not auto-updated.
Last update: 2025-01-04 20:20:16 UTC
README
The Scaffolder package generates the boilerplate for a php package. Running the command creates the following directory structure:
packageName/
|–composer.json (w/ boilerplate)
|–phpunit.xml (w/ boilerplate)
|–src/
|–tests/
|–public/ (optional w/ --playground option)
|–index.php
Requirements
- PHP
Installation
Globally (Composer)
$ composer global require jncampbell/scaffolder
Locally (Composer)
$ composer require jncampbell/scaffolder
Usage
The command will be stored in your vendor/bin directory
The scaffolder new
command generates the boilerplate. A name is required.
$ vendor/bin/scaffolder new nameOfYourPackage
The --playground
option creates a public folder with an index.php page
$ vendor/bin/scaffolder new nameOfYourPackage --playground
Once the boilerplate is generated, fill in the composer.json with your package's information, cd
into your package directory and run a composer install
. Then begin building your package.
##Screenshots
These are the templates that will be generated:
##License
MIT