Yii 2 Basic Project Template is a skeleton Yii 2 application best for rapidly creating small projects.
It's very similar to official yii2-app-basic but has few features for comfort usage in real life:
vendorand etc. directories.
app/ 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 views/ contains view files for the Web application runtime/ contains files generated during runtime tests/ contains various tests for the basic application vendor/ contains dependent 3rd-party packages web/ contains the entry script and Web resources
You can then install this project template using the following command:
php composer.phar global require "fxp/composer-asset-plugin:^1.2.0" php composer.phar create-project --prefer-dist --stability=dev otsec/yii2-app-basic basic
After installing composer dependencies, development environment will initialized automatically. You can reinitialize it manually with:
Edit the file
app/config/common-local.php with real data, for example:
return [ ... 'components' => [ ... 'db' => [ 'dsn' => 'mysql:host=localhost;dbname=yii2basic', 'username' => 'root', 'password' => '1234', ], ], ];
Yii can recognize domain of your site automatically. But if you want to be able to create URLs from
console commands (like for mails generation), you have to specify it manually in
return [ ... 'components' => [ ... 'urlManager' => [ 'baseUrl' => '/', 'hostInfo' => 'http://site.dev/', ], ], ];
config/directory to customize your application as required.
Tests are located in
tests directory. They are developed with Codeception PHP Testing Framework.
By default there are 3 test suites:
Tests can be executed by running
The command above will execute unit and functional tests. Unit tests are testing the system components, while functional tests are for testing user interaction. Acceptance tests are disabled by default as they require additional setup since they perform testing in real browser.
To execute acceptance tests do the following:
tests/acceptance.suite.yml to enable suite configuration
codeception/base package in
codeception/codeception to install full featured
version of Codeception
Update dependencies with Composer
Download Selenium Server and launch it:
java -jar ~/selenium-server-standalone-x.xx.x.jar
# 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
As an alternative way you can use already configured Docker container with older versions of Selenium and Firefox:
docker run --net=host selenium/standalone-firefox:2.53.0
yii2_basic_tests database and update it by applying migrations if you have them.
The database configuration can be found at
Start web server:
Now you can run all available tests
# 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
By default, code coverage is disabled in
codeception.yml configuration file, you should uncomment needed rows to be able
to collect code coverage. You can run your tests and collect coverage with the following command:
#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
You can see code coverage output under the