Yii 2 Basic Project Template
Yii 2 Basic Project Template is a skeleton Yii 2 application best for rapidly creating small projects.
The template contains the basic features including user login/logout and a contact page. It includes all commonly used configurations that would allow you to focus on adding new features to your application.
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
The minimum requirement by this project template that your Web server supports PHP 5.4.0.
Install via Composer
You can then install this project template using the following command:
php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-basic basic
Now you should be able to access the application through the following URL, assuming
basic is the directory
directly under the Web root.
Install from an Archive File
Extract the archive file downloaded from yiiframework.com to
a directory named
basic that is directly under the Web root.
Set cookie validation key in
config/web.php file to some random secret string:
'request' => [ // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation 'cookieValidationKey' => '<secret random string goes here>', ],
You can then access the application through the following URL:
Edit the file
config/db.php with real data, for example:
return [ 'class' => 'yii\db\Connection', 'dsn' => 'mysql:host=localhost;dbname=yii2basic', 'username' => 'root', 'password' => '1234', 'charset' => 'utf8', ];
- Yii won't create the database for you, this has to be done manually before you can access it.
- Check and edit the other files in the
config/directory to customize your application as required.
- Refer to the README in the
testsdirectory for information specific to basic application tests.
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.
Running acceptance tests
To execute acceptance tests do the following:
tests/acceptance.suite.ymlto enable suite configuration
codeception/codeceptionto 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_testsdatabase 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
Code coverage support
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