An open API service indexing awesome lists of open source software.

https://github.com/dotkernel/dot-maker

Programmatically generate Dotkernel project files and directories.
https://github.com/dotkernel/dot-maker

Last synced: 7 days ago
JSON representation

Programmatically generate Dotkernel project files and directories.

Awesome Lists containing this project

README

          

# dot-maker

Programmatically generate Dotkernel project files and directories.

## Documentation

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

## Badges

![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-maker)
![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-maker/2.0.0)

[![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-maker)](https://github.com/dotkernel/dot-maker/issues)
[![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-maker)](https://github.com/dotkernel/dot-maker/network)
[![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-maker)](https://github.com/dotkernel/dot-maker/stargazers)
[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-maker)](https://github.com/dotkernel/dot-maker/blob/2.0/LICENSE)

[![Build Static](https://github.com/dotkernel/dot-maker/actions/workflows/continuous-integration.yml/badge.svg?branch=2.0)](https://github.com/dotkernel/dot-maker/actions/workflows/continuous-integration.yml)
[![codecov](https://codecov.io/gh/dotkernel/dot-maker/graph/badge.svg?token=KT9UA402B4)](https://codecov.io/gh/dotkernel/dot-maker)
[![PHPStan](https://github.com/dotkernel/dot-maker/actions/workflows/static-analysis.yml/badge.svg?branch=2.0)](https://github.com/dotkernel/dot-maker/actions/workflows/static-analysis.yml)

## Installation

Run the following command in your terminal:

```shell
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**.

```json
{
"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](#setup): `composer make`

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