BBSM 是一个基于 yii2 的开源网络生态系统

dev-master 2016-11-27 07:49 UTC

This package is not auto-updated.

Last update: 2024-09-28 20:14:36 UTC


README

Yii 2 基本项目模板是一个骨架 Yii 2 应用,最适合快速创建小型项目。

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

Latest Stable Version Total Downloads Build Status

目录结构

  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 安装

如果您没有 Composer,您可以通过访问 getcomposer.org 上的说明来安装它。

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

php composer.phar global require "fxp/composer-asset-plugin:^1.2.0"
php composer.phar create-project --prefer-dist --stability=dev 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/

配置

数据库

使用真实数据编辑 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 个测试套件

  • 单元测试
  • 功能测试
  • 验收测试

可以通过运行以下命令执行测试

composer exec codecept run

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

运行验收测试

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

  1. tests/acceptance.suite.yml.example 重命名为 tests/acceptance.suite.yml 以启用套件配置

  2. composer.json 中的 codeception/base 包替换为 codeception/codeception 以安装完整的 Codeception 版本

  3. 使用 Composer 更新依赖

    composer update  
    
  4. 下载 Selenium 服务器 并启动它

    java -jar ~/selenium-server-standalone-x.xx.x.jar
    
  5. (可选)创建 yii2_basic_tests 数据库,并应用迁移以更新它(如果您有迁移)。

    tests/bin/yii migrate
    

    数据库配置可以在 config/test_db.php 中找到。

  6. 启动 Web 服务器

    tests/bin/yii serve
    
  7. 现在,您可以运行所有可用的测试

    # run all available tests
    composer exec codecept run
    
    # run acceptance tests
    composer exec codecept run acceptance
    
    # run only unit and functional tests
    composer exec codecept run unit,functional
    

代码覆盖率支持

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

#collect coverage for all tests
composer exec codecept run -- --coverage-html --coverage-xml

#collect coverage only for unit tests
composer exec codecept run unit -- --coverage-html --coverage-xml

#collect coverage for unit and functional tests
composer exec codecept run functional,unit -- --coverage-html --coverage-xml

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