jncampbell/scaffolder

A terminal command to generate php package boilerplate

Scaffolder

The Scaffolder package generates the boilerplate for a php package. Running the command creates the following directory structure:, _(*1)

  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, _(*2)

Locally (Composer)

$ composer require jncampbell/scaffolder, _(*3)

Usage

The command will be stored in your vendor/bin directory, _(*4)

The scaffolder new command generates the boilerplate. A name is required., _(*5)

$ vendor/bin/scaffolder new nameOfYourPackage

The --playground option creates a public folder with an index.php page, _(*6)

$ 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., _(*7)

Screenshots

These are the templates that will be generated:
, _(*8)

License

MIT, _(*9)