README

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

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

目录结构

  assets/             contains assets definition
  commands/           contains console commands (controllers)
  config/             contains application configurations
  controllers/        contains Web controller classes
  docker/             contains Dockerfiles
  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。

安装

Gulp

如果您之前没有安装，请全局安装Gulp

npm install -g gulp-cli

通过Composer安装

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

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

php composer.phar global require "fxp/composer-asset-plugin:^1.2.0"
php composer.phar create-project --prefer-dist --stability=dev jacksontong/yii2-app-basic-docker-gulp-sass basic

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

https:///basic/web/

从存档文件安装

将从yiiframework.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运行

npm start

cp .env-example .env
docker-compose up

// port number from .env file
https://:[NGINX_EXPOSE_PORT]

配置

数据库

使用实际数据编辑文件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 Testing Framework开发。默认情况下，有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

(可选) 创建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 目录下看到代码覆盖率输出。

jacksontong / yii2-app-basic-docker-gulp-sass

维护者

详情