README

Programmatically generate Dotkernel project files and directories.

Documentation

Documentation is available at: https://docs.dotkernel.org/dot-maker/.

Badges

👁 OSS Lifecycle
👁 PHP from Packagist (specify version)

👁 GitHub issues
👁 GitHub forks
👁 GitHub stars
👁 GitHub license

👁 Build Static
👁 codecov
👁 PHPStan

Installation

Run the following command in your terminal:

composer require --dev dotkernel/dot-maker

Setup

Once installed, dot-maker is ready for usage, no need for extra configurations.

(Optional) Add dot-maker to composer.json

Open your project's composer.json and locate the scripts section. If it does not exist, create it at the document's root level.

Register a new script by appending "alias": "dot-maker" to the scripts section, where alias can be any string you want; like, for example, make.

{
 "scripts": {
 "make": "dot-maker"
 }
}

Usage

Invoke dot-maker by executing:

• the bin file in your vendor directory ./vendor/bin/dot-maker
• the (optional) Composer script created during Setup: composer make

Follow the instructions on the screen to create a specific Dotkernel project component.