yii2tech/project-template

Yii 2 Project Template from yii2tech

, _(*1)

Yii 2 Project Template

This project is a skeleton Yii 2 application best for developing complex Web applications with multiple tiers., _(*2)

The template includes three tiers: front end, back end, and console, each of which is a separate Yii application., _(*3)

The template is designed to work in a team development environment., _(*4)

, _(*5)

REQUIREMENTS

Requirements check script:, _(*6)

php requirements.php

INSTALLATION

1. Clone the repository into the project destination directory.
2. Switch the project branch to the needed one: 'master', 'stage', 'live' etc.
3. Run the installation script using following command:

php install.php init/all

Project should be deployed beyond web accessible folder. Actual web root should be created as symlink to the 'web' folder:, _(*7)

ln -s /path/to/project/web /var/www/html/project

ASSET COMPRESSION

For assets (CSS and JavaScript) compression use following command:, _(*8)

cd /path/to/project/root
php yii asset config/frontend-asset-compress.php config/frontend-assets.php

See config/frontend-asset-compress.php file for more details., _(*9)

The 'backend' assets compression is performed as separated command:, _(*10)

cd /path/to/project/root
php yii asset config/backend-asset-compress.php config/backend-assets.php

See config/backend-asset-compress.php file for more details., _(*11)

SITEMAP GENERATION

Sitemap is generated by app\controllers\console\SitemapController::actionGenerate() method. Make sure all pages, which should appear at sitemap are processed in this method. For sitemap generation use following command:, _(*12)

cd /path/to/project/root
php yii sitemap/generate

SELF-UPDATE

After successful installation 'stage' or 'production' server can be updated using 'self-update' command., _(*13)

In order to perform an update, run the following commands:, _(*14)

cd /path/to/project/root
php yii self-update config/self-update.php

GII

Admin section generation:, _(*15)

php yii gii/adminCrud --modelClass="app\models\db\{NAME}" --controllerClass="app\controllers\backend\{NAME}Controller" --searchModelClass="app\models\backend\{NAME}Search" --viewPath="@app/views/backend/{NAME}" --enableI18N=1

Admin section with context generation:, _(*16)

php yii gii/adminCrud --modelClass="app\models\db\{NAME}" --controllerClass="app\controllers\backend\{NAME}Controller" --searchModelClass="app\models\backend\{NAME}Search" --viewPath="@app/views/backend/{NAME}" --contextClass="app\models\db\{CONTEXT}" --enableI18N=1

I18N

Translation messages generation:, _(*17)

php yii message messages/config.php

TESTING

This project supports testing via PHPUnit as well as via Codeception, _(*18)

Regular PHPUnit tests are located under 'tests\unit' directory. In case you have PHPUnit installed you can run them using phpunit command from the project root., _(*19)

Please refer to Codeception Testing manual for the details about Codeception tests setup and running., _(*20)