Yii 2 Advanced Project Template
Yii 2 Practical Project Template is a skeleton Yii 2 application based on the yii2-advanced template best for developing complex Web applications with multiple tiers. The template allows a practical method to directly access the frontend from the app root.
The template includes three tiers: front end, back end, and console, each of which is a separate Yii application.
The template is designed to work in a team development environment. It supports deploying the application in different environments.
After installing an
app in the yii2-advanced application you normally would access the
However, in many practical scenarios (especially on shared and single domain hosts) one would want their users to directly access frontend as:
yii2-app-practical enables you to achieve just that by carefully moving and rearranging the
bootstrap files and web components of frontend to work directly out of the app root. The
frontend/web is entirely eliminated and one can directly access the application frontend
All other aspects of the app configuration remain the same as the yii2-advanced app. The
will remain as is. The frontend config, assets, models, controllers, views, widgets and components, will still reside within
frontend directory. It is just the web access that is moved out to app root.
- The template has some security preconfigured for users with Apache web servers. It has a default
.htaccesssecurity configuration setup.
- The template has prettyUrl enabled by default and the changes have been made to
.htaccessas well as
urlManagercomponent config in the common config directory.
- The template has isolated cookie settings for backend and frontend so that you can seamlessly access frontend and backend from same client.
The config files includes special
csrfcookie parameter settings for backend. Edit it according to your needs if necessary.
Detailed documentation on yii2-app-advanced concepts and usage can be referred at docs/guide/README.md.
The minimum requirement by this application template that your Web server supports PHP 5.4.0.
You can choose to install the application using one of the following methods.
You can then install the application using the following command:
php composer.phar global require "fxp/composer-asset-plugin:~1.1.1" php composer.phar create-project --prefer-dist --stability=dev kartik-v/yii2-app-practical practical
Download the archive file directly to a directory named
practical that is directly under the Web root.
Note: When using a archive file method, the vendor folder is not automatically created. You must download the latest yii2-advanced archive and then extract the vendor folder from here. Then you must copy this folder directly under the app root (i.e.
After this is complete, follow the instructions given in "GETTING STARTED".
After you install the application, you have to conduct the following steps to initialize the installed application. You only need to do these once for all.
- Run command
initto initialize the application with a specific environment.
- Create a new database and adjust the
- Apply migrations with console command
yii migrate. This will create tables needed for the application to work.
- Set document roots of your Web server:
- for frontend
/path/to/yii-application/and using the URL
- for backend
/path/to/yii-application/backend/web/and using the URL
To login into the application, you need to first sign up, with any of your email address, username and password. Then, you can login into the application with same email address and password at any time.
- Edit the config files as needed. Especially set the correct paths for the user identity cookie in
You can read the yii2-advanced application guide to understand details on working with the advanced application.
tests section README for setting up the tests. For details of testing in Yii 2.0, read the testing overview and setup within the Yii 2.0 Guide. Setting up the testing environment broadly involves the following steps.
Install additional composer packages:
php composer.phar require --dev "codeception/codeception: 2.0" "codeception/specify: *" "codeception/verify: *"
This application boilerplate uses database in testing, so you should create three databases that are used in tests:
yii2_practical_unit- database for unit tests;
yii2_practical_functional- database for functional tests;
yii2_practical_acceptance- database for acceptance tests.
To make your database up to date, you can run in needed test folder
yii migrate, for example
if you are starting from
frontend tests then you should run
yii migrate in each suite folder
it will upgrade your database to the last state according migrations.
To be able to run acceptance tests you need a running webserver. For this you can use the php builtin server and run it in the directory where your main project folder is located. For example if your application is located in
/www/practical all you need to is:
cd /www and then
php -S 127.0.0.1:8080 because the default configuration of acceptance tests expects the url of the application to be
If you already have a server configured or your application is not located in a folder called
practical, you may need to adjust the
After that is done you should be able to run your tests, for example to run
frontend tests do:
In similar way you can run tests for other application tiers -
You can also adjust you application suite configs and
_bootstrap.php settings to use other urls and files, as it is done in