README

Yii 2 Basic 项目模板

Yii 2 Basic 项目模板是一个用于快速创建小型项目的最佳骨架 Yii 2 应用程序。

该模板包含基本功能，包括用户登录/注销和联系页面。它包含所有常用的配置，使您能够专注于添加新功能到您的应用程序。

目录结构

  assets/             contains assets definition
  commands/           contains console commands (controllers)
  config/             contains application configurations
  controllers/        contains Web controller classes
  mail/               contains view files for e-mails
  models/             contains model classes
  runtime/            contains files generated during runtime
  tests/              contains various tests for the basic application
  vendor/             contains dependent 3rd-party packages
  views/              contains view files for the Web application
  web/                contains the entry script and Web resources

需求

本项目模板的最小需求是您的 Web 服务器支持 PHP 5.4.0。

安装

您可以使用以下命令安装此项目模板

composer create-project kerneldos/yii2-basic-modules-structure

或者

从 github 克隆存储库

git clone https://github.com/kerneldos/yii2-basic-modules-structure.git .

更新 composer 组件

composer update

如果您没有 Composer，您可以通过遵循 getcomposer.org 上的说明进行安装。

配置

数据库

编辑 config/db.php 文件，使用实际数据，例如

return [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=localhost;dbname=yii2basic',
    'username' => 'root',
    'password' => '1234',
    'charset' => 'utf8',
];

注意事项

Yii 不会为您创建数据库，这必须在您能够访问它之前手动完成。
检查并编辑 config/ 目录中的其他文件，以根据需要自定义您的应用程序。
有关基本应用程序测试的特定信息，请参阅 tests 目录中的 README。

测试

测试位于 tests 目录中。它们使用 Codeception PHP 测试框架开发。默认情况下，有 3 个测试套件

单元
功能
验收

可以使用以下命令执行测试

vendor/bin/codecept run

上述命令将执行单元和功能测试。单元测试用于测试系统组件，而功能测试用于测试用户交互。验收测试默认禁用，因为它们需要额外的设置，因为它们在真实浏览器中进行测试。

运行验收测试

要执行验收测试，请执行以下操作

将 tests/acceptance.suite.yml.example 重命名为 tests/acceptance.suite.yml 以启用套件配置
将 composer.json 中的 codeception/base 包替换为 codeception/codeception 以安装功能更全面的 Codeception 版本
使用 Composer 更新依赖项
```
composer update  
```

下载 Selenium Server 并启动它

java -jar ~/selenium-server-standalone-x.xx.x.jar

如果您使用的是从 v48 开始的 Firefox 浏览器或从 v53 开始的 Google Chrome，则必须下载 GeckoDriver 或 ChromeDriver 并使用它启动 Selenium

# for Firefox
java -jar -Dwebdriver.gecko.driver=~/geckodriver ~/selenium-server-standalone-3.xx.x.jar

# for Google Chrome
java -jar -Dwebdriver.chrome.driver=~/chromedriver ~/selenium-server-standalone-3.xx.x.jar

作为另一种方式，您可以使用已配置的 Docker 容器，其中包含旧版本的 Selenium 和 Firefox

docker run --net=host selenium/standalone-firefox:2.53.0

(可选) 创建 yii2_basic_tests 数据库，并应用迁移以更新它（如果有的话）。
```
tests/bin/yii migrate
```
数据库配置可以在 config/test_db.php 中找到。
启动 Web 服务器
```
tests/bin/yii serve
```

现在您可以运行所有可用的测试

# run all available tests
vendor/bin/codecept run

# run acceptance tests
vendor/bin/codecept run acceptance

# run only unit and functional tests
vendor/bin/codecept run unit,functional

代码覆盖率支持

默认情况下，在 codeception.yml 配置文件中禁用了代码覆盖率，您应该取消注释所需的行以能够收集代码覆盖率。您可以使用以下命令运行测试并收集覆盖率

#collect coverage for all tests
vendor/bin/codecept run -- --coverage-html --coverage-xml

#collect coverage only for unit tests
vendor/bin/codecept run unit -- --coverage-html --coverage-xml

#collect coverage for unit and functional tests
vendor/bin/codecept run functional,unit -- --coverage-html --coverage-xml

您可以在 tests/_output 目录下查看代码覆盖率输出。

kernel-dos / yii2-basic-modules-structure

维护者

详细信息