README

Boiler是一个框架，帮助您创建（Web）项目，而不是使用骨架项目。创建此项目的原因是通过不更新您的骨架项目中的依赖项来节省时间。

安装

composer global require glamorous/boiler

确保~/.composer/vendor/bin目录在您的系统“PATH”中。

如何使用它？

为您的（自定义）骨架模板创建一个文件夹

您可以为boiler添加多个目录以允许它搜索模板。要添加目录，您只需运行

boiler setup my/path

创建骨架模板

单个骨架文件

骨架模板是一个简单的YAML文件，包含执行几个步骤以创建项目的结果。

name: Default project

steps:
  - create_readme
  - git

create_readme:
  name: Readme
  script:
    - touch README.md
    - echo '{#PROJECT_NAME#}
           ==============
           
           This is the default README.md created by boiler.' >README.md

git:
    name: Initialized Git and create first commit
    script:
        - git init
        - git commit -m 'Initial commit'

在上面的示例中

• 添加了一个README.md文件
• 初始化git并创建了第一个提交

骨架目录

就像单个骨架YAML文件一样，您可以创建一个与YAML文件相同名称的目录。该目录中包含的所有文件都将复制到新目录中。唯一不复制的是yaml模板文件。

使用您创建的模板创建项目

基于default.yml模板创建项目与以下操作一样简单

boiler create default

骨架脚本将创建一个名为default的目录，并从您的模板运行脚本以创建您的项目。

额外选项

--dir

自己定义目录的名称

--name

定义项目的名称（可以在模板中用作{#PROJECT_NAME#}）

包含模板

可以包含其他创建的模板，以便重复使用具有额外功能的模板。而不是为每种类型的项目重复特定的函数，只需包含它并调用它；

functions.yml在运行boiler setup的目录中

create_readme:
  name: Readme
  script:
    - touch README.md
    - echo '{#PROJECT_NAME#}
           ==============
           
           This is the default README.md created by boiler.' >README.md

git:
    name: Initialized Git and create first commit
    script:
        - git init
        - git commit -m 'Initial commit'

default.yml在运行boiler setup的目录中

name: Default project

include:
  - functions

steps:
  - create_readme
  - git

命令

boiler create my-template：根据“my-template”创建应用程序。

boiler setup my/path：将目录设置为模板目录（路径是可选的，将采用当前目录）。

boiler remove my/path：从模板目录中删除目录（路径是可选的，将采用当前目录）。

boiler paths：显示所有包含的模板目录。

变更日志

请参阅CHANGELOG了解最近更改的更多信息。

测试

$ composer test

贡献

有关详细信息，请参阅CONTRIBUTING。要查看贡献者列表： 所有贡献者。

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。