package-for-laravel/new-project

此包已被弃用且不再维护。未建议替代包。

Laravel 框架和工具的启动工具箱

4.0.2 2020-02-09 02:00 UTC

README

ARCHIVED: This project is archived and no longer maintained.

之前为 Laravel Boot

我用来构建项目的 Laravel 启动框架。

要使用此框架创建新项目,请运行以下命令

composer create-project package-for-laravel/new-project $1

其中 $1 是您希望安装的文件夹名称。

开发说明

实际上,您可以使用类似 Valet 或创建自己的虚拟机设置来使用此项目。您还需要担心系统上是否有兼容的 NPM 版本(如果您想使用 nvm 管理它,也是如此。然而,此项目已针对 Docker 进行优化。您可以在 docker-compose.yml 文件中查看配置,并在 .env 文件中查看环境变量配置。

如果您使用的是类似 PHPStorm 的工具,您可以配置它自动使用各种 Docker 容器,只需将其指向组合文件即可。否则,您可以使用以下有用的脚本

  • bin/dev/npm 将在 Docker 容器中运行兼容版本的 NPM,但使用您的本地文件系统作为源。
  • bin/dev/composer 允许您在 Docker 环境中安装 composer 依赖项或运行 composer 脚本。此外,它将共享您的本地文件系统缓存以加快容器之间的工作。
  • bin/dev/artisan 将在 PHP Docker 实例中运行 artisan 脚本。
  • bin/dev/test 将使用 PHPUnit 运行 PHP 单元测试。
  • bin/dev/test-with-coverage 将运行相同的测试,但将在 tests/html-coverage 中生成 html 覆盖率。

不同的 PHP 容器

有两种不同的 PHP 容器。第一种是基础版本,可用于生产部署。但它基本上是配置没有 xdebug。第二种是带有 -debug 后缀的 php 实例,这表示它始终加载了调试工具(例如当前 xdebug)。常规实例用于运行单元测试。调试实例用于开发(以便您可以使用调试)以及用于生成 html 代码覆盖率。

配置

所有配置选项都定义在 .env 文件中。您还可以在那里更改 Docker 设置。

单元测试

可以使用 composer test、如果使用 Docker,则使用 bin/dev/composer test 运行单元测试,或者如果您想自定义 Docker 中运行的单元测试参数,则使用 bin/dev/test。建议使用 bin/dev/test(或使用 PHPStorm 集成)。

使用 npm run test 运行 JavaScript 测试,或在 Docker 内部使用 bin/dev/npm run test

IDE 辅助工具

composer ide-helper-update

生成代码行数

composer phplocdocs/phploc.txt 中生成代码行数输出

npm run jslocdocs/jsloc.txt 中生成代码行数输出

PHP 检查

composer php-lint 将运行 PHPCS、PHP-Code-Sniffer(以 Dry Run 方式)和 PHP Copy Paste Detector。

部署

composer 文件中有一个部署步骤的部分

composer deploy 会运行 Laravel 的配置和路由缓存。

Laravel 自动化启动函数

  • 使用创建项目格式安装 Laravel
  • .env.example 复制到 .env

致谢

此包由 Aaron Saray 创建和维护。