yii2tech / project-template
Yii 2 Project Template from yii2tech
Installs: 66
Dependents: 0
Suggesters: 0
Security: 0
Stars: 53
Watchers: 13
Forks: 10
Open Issues: 0
Type:project
Requires
- php: >=5.6.0
- yii2tech/admin: *
- yii2tech/ar-softdelete: *
- yii2tech/authlog: *
- yii2tech/config: *
- yii2tech/filedb: *
- yii2tech/install: *
- yii2tech/selfupdate: *
- yii2tech/sitemap: *
- yiisoft/yii2: ~2.0.14
- yiisoft/yii2-bootstrap: ~2.0.0
- yiisoft/yii2-swiftmailer: ~2.0.0 || ~2.1.0
Requires (Dev)
- codeception/base: ^2.2.3
- codeception/verify: ~0.3.1
- yiisoft/yii2-debug: *
- yiisoft/yii2-faker: *
- yiisoft/yii2-gii: *
This package is auto-updated.
Last update: 2022-01-10 10:30:16 UTC
README
Yii 2 Project Template
This project is a skeleton Yii 2 application best for developing complex Web applications with multiple tiers.
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.
REQUIREMENTS
Requirements check script:
php requirements.php
INSTALLATION
- Clone the repository into the project destination directory.
- Switch the project branch to the needed one: 'master', 'stage', 'live' etc.
- 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:
ln -s /path/to/project/web /var/www/html/project
ASSET COMPRESSION
For assets (CSS and JavaScript) compression use following command:
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.
The 'backend' assets compression is performed as separated command:
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.
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:
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.
In order to perform an update, run the following commands:
cd /path/to/project/root
php yii self-update config/self-update.php
GII
Admin section generation:
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:
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:
php yii message messages/config.php
TESTING
This project supports testing via PHPUnit as well as via Codeception
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.
Please refer to Codeception Testing manual for the details about Codeception tests setup and running.