Yii 2 Basic Project Template

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:

• Environment module ported from yii2-app-advanced.
• Application code separated from runtime, vendor and etc. directories.

DIRECTORY STRUCTURE

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

INSTALLATION

Install via Composer

If you do not have Composer, you may install it by following the instructions at getcomposer.org.

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:

php init

CONFIGURATION

Database

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',
        ],
    ],
];

Domain and URL creation

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 app/config/common-local.php file:

return [
    ...

    'components' => [
        ... 

        'urlManager' => [
            'baseUrl' => '/',
            'hostInfo' => 'http://site.dev/',
        ],
    ],
];

NOTES

• 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 TESTING section of this README file for information specific to basic application tests.

TESTING

Tests are located in tests directory. They are developed with Codeception PHP Testing Framework. By default there are 3 test suites:

• unit
• functional
• acceptance

Tests can be executed by running

vendor/bin/codecept run

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:

1. Rename tests/acceptance.suite.yml.example to tests/acceptance.suite.yml to enable suite configuration

2. Replace codeception/base package in composer.json with codeception/codeception to install full featured version of Codeception

3. Update dependencies with Composer

   composer update  

4. Download Selenium Server and launch it:

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

   In case of using Selenium Server 3.0 with Firefox browser since v48 or Google Chrome since v53 you must download GeckoDriver or ChromeDriver and launch Selenium with it:

   # 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

5. (Optional) Create yii2_basic_tests database and update it by applying migrations if you have them.

   yii_test migrate

   The database configuration can be found at tests/config/common-local.php.

6. Start web server:

   yii_test serve

7. 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 tests/_output directory.