Yii 2 Basic Plus Project Template is a skeleton Yii 2 application best for
rapidly creating small projects., (*1)
The template contains the basic features including user login/logout using popular dektrium/user module and gentelella theme.
It includes all commonly used configurations that would allow you to focus on adding new
features to your application., (*2)
, (*3)
DIRECTORY STRUCTURE
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
REQUIREMENTS
The minimum requirement by this project template that your Web server supports PHP 5.4.0., (*4)
INSTALLATION
Install via Composer
If you do not have Composer, you may install it by following the instructions
at getcomposer.org., (*5)
You can then install this project template using the following command:, (*6)
php composer.phar create-project --prefer-dist --stability=dev soap/yii2-app-basic-plus myapp
Or you may use this command for globally install composer:, (*7)
composer create-project --prefer-dist --stability=dev soap/yii2-app-basic-plus myapp
Now you should be able to access the application through the following URL, assuming myapp is the directory
directly under the Web root., (*8)
http://localhost/myapp/web/
Or if you want to quickly test, run local web server provided by Yii2:, (*9)
yii serve
Then access your application using:, (*10)
http://localhost:8080/myapp/
Install with Docker
Update your vendor packages, (*11)
docker-compose run --rm php composer update --prefer-dist
Run the installation triggers (creating cookie validation code), (*12)
docker-compose run --rm php composer install
Start the container, (*13)
docker-compose up -d
You can then access the application through the following URL:, (*14)
http://127.0.0.1:8000
NOTES:
- Minimum required Docker engine version 17.04 for development (see Performance tuning for volume mounts)
- The default configuration uses a host-volume in your home directory .docker-composer for composer caches, (*15)
CONFIGURATION
Database
Edit the file config/db.php with real data, for example:, (*16)
return [
'class' => 'yii\db\Connection',
'dsn' => 'mysql:host=localhost;dbname=yii2-basic-plus',
'username' => 'root',
'password' => '',
'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 the config/ directory to customize your application as required.
- Refer to the README in the tests directory for information specific to basic application tests., (*17)
RUN MIGRATIONS
Run migration updates on database for dektrium/yii2-user as below:, (*18)
yii migrate/up --migrationPath=@vendor/dektrium/yii2-user/migrations, (*19)
TESTING
Tests are located in tests directory. They are developed with Codeception PHP Testing Framework.
By default there are 3 test suites:, (*20)
unitfunctionalacceptance
Tests can be executed by running, (*21)
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., (*22)
Running acceptance tests
To execute acceptance tests do the following:, (*23)
-
Rename tests/acceptance.suite.yml.example to tests/acceptance.suite.yml to enable suite configuration, (*24)
-
Replace codeception/base package in composer.json with codeception/codeception to install full featured
version of Codeception, (*25)
-
Update dependencies with Composer, (*26)
composer update
-
Download Selenium Server and launch it:, (*27)
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:, (*28)
# 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:, (*29)
docker run --net=host selenium/standalone-firefox:2.53.0
-
(Optional) Create yii2_basic_tests database and update it by applying migrations if you have them., (*30)
tests/bin/yii migrate
The database configuration can be found at config/test_db.php., (*31)
-
Start web server:, (*32)
tests/bin/yii serve
-
Now you can run all available tests, (*33)
# 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:, (*34)
#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., (*35)
Wallogit.com
