README

Yii 2 Modern Basic 项目模板

Yii 2 Modern Basic 项目模板是一个骨架 Yii 2 应用程序，非常适合快速创建小型项目。

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

兼容性

PHP 7.2 或更高版本
PHPUnit 8.4
Codeception 3.1
Selenium 3.141.59
Twitter Bootstrap 4
Docker 18.06 或更高版本

目录结构

  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 7.2.0。

安装

通过 Composer 安装

如果您没有 Composer，您可以按照 getcomposer.org 上的说明进行安装。

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

composer create-project --prefer-dist nowmovesoft/yii2-app-basic-modern basic

现在您应该可以通过以下 URL 访问应用程序，假设 basic 是 Web 根目录下的目录。

https:///basic/web/

从存档文件安装

将从 github.com 下载的存档文件解压缩到 Web 根目录下的名为 basic 的目录中。

在 config/web.php 文件中将 cookie 验证密钥设置为某个随机密钥字符串

'request' => [
    // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
    'cookieValidationKey' => '<secret random string goes here>',
],

然后您可以通过以下 URL 访问应用程序

https:///basic/web/

使用 Docker 安装

更新您的供应商包

docker-compose run --rm php composer update --prefer-dist

运行安装触发器（创建 cookie 验证代码）

docker-compose run --rm php composer install

启动容器

docker-compose up -d

然后您可以通过以下 URL 访问应用程序

http://127.0.0.1:8000

注意

开发所需的最低 Docker 引擎版本为 18.06（请参阅性能调优卷挂载）
默认配置使用您主目录中的宿主卷 .docker-composer 作为 composer 缓存

配置

数据库

使用真实数据编辑文件 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浏览器，并且使用Selenium Server 3.0，则必须下载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
```
作为替代方法，您可以使用已经配置好的带有较旧版本Selenium和Firefox的Docker容器
```
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目录下查看代码覆盖率输出。

nowmovesoft / yii2-app-basic-modern

维护者

详细信息