The minimum requirement by this project template that your Web server supports PHP 7+.
Install composer.
You can then install this project template using the following command:
composer create-project --prefer-dist yarcode/yii2-app-yarcode yarcode
сd yarcode
php init
Change the settings in the common/config/main-local.php and apply migrations. Make sure that you are properly configured to connect to the database.
php yii migrate
The template installation is now complete.
The root directory contains the following subdirectories and files:
api web application implements simple REST API
component/ contains components api
config/ contains api configurations
models/ contains api-specific model classes
runtime/ contains files generated during runtime
tests/ contains tests for frontend application
web/ contains the entry script
codeception.yaml configuration file for Codeception
backend backend web application
assets/ contains application assets such as JavaScript and CSS
config/ contains backend configurations
controllers/ contains Web controller classes
models/ contains backend-specific model classes
runtime/ contains files generated during runtime
tests/ contains tests for backend application
views/ contains view files for the Web application
web/ contains the entry script and Web resources
codeception.yaml configuration file for Codeception
common files shared for the whole application
component/ contains shared components
config/ contains shared configurations
fixtures/ contains fixtures
mail/ contains view files for e-mails
models/ contains model classes used in both backend and frontend
tests/ contains tests for common classes
console console application
config/ contains console configurations
controllers/ contains console controllers (commands)
migrations/ contains database migrations
models/ contains console-specific model classes
runtime/ contains files generated during runtime
environments/ contains environment-based overrides
frontend frontend web application
assets/ contains application assets such as JavaScript and CSS
config/ contains frontend configurations
controllers/ contains Web controller classes
models/ contains frontend-specific model classes
runtime/ contains files generated during runtime
tests/ contains tests for frontend application
views/ contains view files for the Web application
web/ contains the entry script and Web resources
widgets/ contains frontend widgets
codeception.yaml configuration file for Codeception
tools/ contains helper for IDE
vendor/ contains dependent 3rd-party packages
.gitignore contains a list of directories ignored by git version system.
.php_cs configuration file for PHP Coding Standards Fixer
.travis.yaml configuration file for Travis CI
codeception.yaml cnfiguration file for Codeception
composer.json composer config described in Configuring Composer.
init initialization script described in Configuration and environments.
init.bat same for Windows.
LICENSE.md license info. Put your project license there.
README.md basic info about installing template (EN).
README-RU.md basic info about installing template (RU).
requirements.php Yii requirements checker.
yii console application bootstrap.
yii.bat same for Windows.
Tests are in the test catalogs {application}/tests.
They are developed with Codeception PHP Testing Framework. By default there are 2 test suites for each applications(api, frontend, backend):
- unit
- functional
For more information about testing Yii2 applications, read here
You can run all the tests that are in the template
vendor\bin\codecept run
It is possible to run only unit or only functional tests for the application, for example
vendor\bin\codecept run unit -c backend
vendor\bin\codecept run functional -c api
Also you can run some specific test by specifying the path to it
vendor\bin\codecept run functional -c api v1/ApiCest
For debugging, it can be convenient to run tests with the flags -f and --debug
vendor\bin\codecept run functional -c api v1/ApiCest -f --debug
To automatically build and test the application in a template, use Travis CI, конфигурация находится в файле .travis.yaml.
In the configuration file added PHP Coding Standards Fixer.
This tool allows us to automatically check the project code for compliance with standards and rules.
The configuration is in the file .php_cs in the project's root directory.
Execute the command to verify the code for compliance with the PSR-2 standard
vendor/bin/php-cs-fixer fix -v --dry-run
