akam / yii2-module-basic-demo
仅用于共享模块演示
Requires
- php: >=5.6.0
- yiisoft/yii2: ~2.0.14
- yiisoft/yii2-bootstrap4: ~2.0.0
- yiisoft/yii2-swiftmailer: ~2.0.0 || ~2.1.0
Requires (Dev)
- codeception/codeception: ^4.0
- codeception/module-asserts: ^1.0.0
- codeception/module-filesystem: ^1.0.0
- codeception/module-yii2: ^1.0.0
- codeception/specify: ~0.4.6
- codeception/verify: ~0.5.0 || ~1.1.0
- symfony/browser-kit: >=2.7 <=4.2.4
- yiisoft/yii2-debug: ~2.1.0
- yiisoft/yii2-faker: ~2.0.0
- yiisoft/yii2-gii: ~2.2.0
This package is not auto-updated.
Last update: 2024-09-24 20:28:13 UTC
README
Yii 2 基础项目模板
Yii 2 基础项目模板是一个最佳用于快速创建小型项目的 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.6.0。
安装
通过 Composer 安装
如果您没有 Composer,您可以按照 getcomposer.org 上的说明进行安装。
然后,您可以使用以下命令安装此项目模板
composer create-project --prefer-dist yiisoft/yii2-app-basic 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 安装
更新您的供应商包
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 引擎版本
17.04
用于开发(请参阅 性能调优卷挂载) - 默认配置使用您的家目录中的主机卷
.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 服务器 并启动它
java -jar ~/selenium-server-standalone-x.xx.x.jar
如果在版本 48 或更高版本的 Firefox 浏览器以及版本 53 或更高版本的 Google Chrome 浏览器中使用 Selenium 服务器 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
-
(可选) 创建
yii2basic_test
数据库,并根据需要应用迁移来更新它。tests/bin/yii migrate
数据库配置可以在
config/test_db.php
文件中找到。 -
启动网络服务器
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 --coverage-html --coverage-xml
#collect coverage only for unit tests
vendor/bin/codecept run unit --coverage --coverage-html --coverage-xml
#collect coverage for unit and functional tests
vendor/bin/codecept run functional,unit --coverage --coverage-html --coverage-xml
您可以在 tests/_output
目录下查看代码覆盖率输出。