soap/yii2-app-basic-plus

带扩展的Yii 2基础项目模板,可直接使用

安装: 52

依赖: 0

建议: 0

安全: 0

星标: 1

关注者: 4

分支: 0

开放问题: 0

类型:项目

v0.0.2 2018-06-11 17:17 UTC

This package is not auto-updated.

Last update: 2024-09-23 07:47:09 UTC


README

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

模板包含基本功能,包括使用流行的dektrium/user模块和gentelella主题的用户登录/登出。它包含所有常用配置,让您可以专注于添加新功能到您的应用。

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 create-project --prefer-dist --stability=dev soap/yii2-app-basic-plus myapp

或者,您也可以使用以下命令全局安装composer

composer create-project --prefer-dist --stability=dev soap/yii2-app-basic-plus myapp

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

https:///myapp/web/

或者,如果您想快速测试,可以运行Yii2提供的本地Web服务器

yii serve

然后使用以下方式访问您的应用程序

https://:8080/myapp/

使用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(参见卷挂载的性能调优
  • 默认配置使用主目录中的host-volume .docker-composer作为composer缓存

配置

数据库

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

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

注意

  • Yii不会为您创建数据库,您必须手动创建它才能访问。
  • 检查并编辑config/目录中的其他文件,根据需要自定义应用程序。
  • 有关基本应用程序测试的详细信息,请参阅tests目录中的README。

运行迁移

对dektrium/yii2-user数据库运行以下迁移更新

yii migrate/up --migrationPath=@vendor/dektrium/yii2-user/migrations

测试

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

  • unit
  • functional
  • acceptance

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

vendor/bin/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 Server并启动它

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

    如果使用从v48版本开始Firefox浏览器或从v53版本开始Google Chrome浏览器与Selenium Server 3.0,您必须下载GeckoDriverChromeDriver,并用它来启动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
    
  5. (可选) 创建yii2_basic_tests数据库,并根据需要应用迁移来更新它。

    tests/bin/yii migrate
    

    数据库配置文件位于config/test_db.php

  6. 启动Web服务器

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

    # 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目录下查看代码覆盖率输出。