Repository files navigation

Yii 2 Basic Project Template is a skeletonYii 2 application best forrapidly 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 newfeatures 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 7.4.

If you do not haveComposer, you may install it by following the instructionsatgetcomposer.org.

You can then install this project template using the following command:

composer create-project --prefer-dist yiisoft/yii2-app-basic basic

Now you should be able to access the application through the following URL, assumingbasic is the directorydirectly under the Web root.

http://localhost/basic/web/

Extract the archive file downloaded fromyiiframework.com toa directory namedbasic that is directly under the Web root.

Set cookie validation key inconfig/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:

http://localhost/basic/web/

Update your vendor packages

docker-compose run --rm php composer update --prefer-dist

Run the installation triggers (creating cookie validation code)

docker-compose run --rm php composer install

Start the container

docker-compose up -d

You can then access the application through the following URL:

http://127.0.0.1:8000

NOTES:

• Minimum required Docker engine version17.04 for development (seePerformance tuning for volume mounts)
• The default configuration uses a host-volume in your home directory.docker-composer for composer caches

Edit the fileconfig/db.php with real data, for example:

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

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 theconfig/ directory to customize your application as required.
• Refer to the README in thetests directory for information specific to basic application tests.

Tests are located intests directory. They are developed withCodeception 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 functionaltests are for testing user interaction. Acceptance tests are disabled by default as they require additional setup sincethey perform testing in real browser.

To execute acceptance tests do the following:

1. Renametests/acceptance.suite.yml.example totests/acceptance.suite.yml to enable suite configuration

2. Replacecodeception/base package incomposer.json withcodeception/codeception to install full-featuredversion of Codeception

3. Update dependencies with Composer

   composer update

4. DownloadSelenium 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 downloadGeckoDriver orChromeDriver and launch Selenium with it:

   # for Firefoxjava -jar -Dwebdriver.gecko.driver=~/geckodriver ~/selenium-server-standalone-3.xx.x.jar# for Google Chromejava -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) Createyii2basic_test database and update it by applying migrations if you have them.

   tests/bin/yii migrate

   The database configuration can be found atconfig/test_db.php.

6. Start web server:

   tests/bin/yii serve

7. Now you can run all available tests

   # run all available testsvendor/bin/codecept run# run acceptance testsvendor/bin/codecept run acceptance# run only unit and functional testsvendor/bin/codecept run unit,functional

By default, code coverage is disabled incodeception.yml configuration file, you should uncomment needed rows to be ableto collect code coverage. You can run your tests and collect coverage with the following command:

#collect coverage for all testsvendor/bin/codecept run --coverage --coverage-html --coverage-xml#collect coverage only for unit testsvendor/bin/codecept run unit --coverage --coverage-html --coverage-xml#collect coverage for unit and functional testsvendor/bin/codecept run functional,unit --coverage --coverage-html --coverage-xml

You can see code coverage output under thetests/_output directory.