greeflas/default-project

这是PHP项目的默认结构。

v1.7.0 2020-08-16 11:04 UTC

README

这是PHP项目的默认结构。使用此模板可以加快创建新项目的速度:开源、专有、测试、演示等。

此模板为PHPUnitPHP-CS-Fixer库提供了基本配置,配置了composer.json中的PSR-4命名空间用于源代码和测试,.gitignore中包含基本文件和目录以排除Git,变更日志文件和README文件带有酷炫徽章:)

Packagist Packagist Custom badge

安装

要基于此模板创建新项目,只需执行以下命令

$ composer create-project greeflas/default-project project-name

注意:如果您不想将开发依赖项安装到项目中,可以在create-project标志后添加--no-dev

用法

您需要做的主要更改

  1. 更新composer.json文件的namedescriptionkeywordsauthors部分,行2-4行9-10

  2. 更新.php_cs.dist文件中的模板头部,行4-9

  3. 更新LICENSE文件中的版权信息,行3

您可能需要做的其他更改

  1. composer.json中更改源代码的命名空间,行23和测试的命名空间行28

  2. composer.json中更改PHP版本,行16

  3. .php_cs.dist文件中更改代码风格的规则。

  4. 将一些新文件和目录添加到.gitignore文件中,以排除它们从Git中。

  5. 根据您的项目更新readme

  6. 根据您的项目更新变更日志

代码风格修复器

要检查代码风格,请运行以下命令

$ composer cs-check

要修复代码风格,请运行以下命令

$ composer cs-fix

测试

您可以使用composer命令运行测试

$ composer tests

许可证

license

本项目根据BSD-3-Clause许可证发布。

版权(c)2018 - 2020,Volodymyr Kupriienko