README

关于 Ark Installer

Ark Installer 是一个用于创建新的 Ark 项目的软件包。

安装

$ composer global require unik-codes/ark-installer

使用方法

Ark Installer 包含 3 个主要命令

ark new <项目名称> <路径> - 创建一个新的 Ark 项目
ark install <组件名> - 将 Ark 组件安装到现有的 Laravel 项目中
ark compose <路径> - 安装 Ark 依赖项

创建新的 Ark 项目

要创建新的 Ark 项目，只需运行

$ ark new "You Project Name"

Ark 应该在当前路径下的 your-project-name 目录中创建。

如果您需要在不同的路径中创建新的 Ark 项目，可以提供第二个参数

$ ark new "You Project Name" "/var/www/"

Ark 应该在 /var/www/your-project-name 中创建。

安装 Ark 依赖项

您可以通过运行以下命令将 Ark 相关软件包安装到现有的 Laravel 项目中

$ ark compose "/path-to-your-project"

Ark 依赖于以下软件包，您可能需要在 Laravel 项目中进一步设置 Ark。

将 Ark 组件安装到现有的 Laravel 项目中

您可以使用 ark install <组件名称> 来安装相关组件。

可用组件

medialibrary
migration
docs
seeder
support
model

要安装组件

$ ark install model "/path-to-your-project"

请注意，某些组件依赖于安装 Ark 依赖项。

贡献

感谢您考虑为 Ark Installer 贡献！

错误报告

为了鼓励积极的协作，强烈鼓励提交拉取请求，而不仅仅是错误报告。"错误报告"也可以以包含失败测试的拉取请求的形式发送。

但是，如果您提交错误报告，您的问题应包含标题和关于问题的清晰描述。您还应尽可能提供相关信息和展示问题的代码示例。错误报告的目标是使您和他人能够轻松地复制错误并开发修复方案。

记住，错误报告是在希望有相同问题的其他人能够与您一起解决它的情况下创建的。不要期望错误报告会自动看到任何活动，或者其他人会立即修复它。创建错误报告的目的是帮助您和其他人开始解决问题的道路。

编码风格

Ark Installer 遵循 PSR-2 编码标准和 PSR-4 自动加载标准。

您可以使用 PHP CS Fixer 来保持标准化的代码。PHP CS Fixer 的配置可以在 .php_cs 中找到。

安全漏洞

如果您在Ark安装程序中发现安全漏洞，请发送电子邮件至Nasrul Hazim（nasrulhazim.m@gmail.com），邮箱地址为nasrulhazim.m@gmail.com。所有安全漏洞都将得到及时处理。

测试

要运行测试，请在您的终端中输入vendor/bin/phpunit。

要实现代码覆盖率，请确保已安装PHP XDebug，然后运行以下命令

$ vendor/bin/phpunit -v --coverage-text --colors=never --stderr

许可证

Ark安装程序是一个开源软件，遵循MIT许可证。

unik-codes / ark-installer

维护者

详细信息