Yii 2 Advanced Project Template with Deployer.php support
Yii 2 Advanced Project Template with Deployer.php support is a skeleton Yii 2 application for
developing complex Web applications with multiple tiers., (*1)
The template includes three tiers: front end, back end, and console, each of which
is a separate Yii application., (*2)
The template is designed to work in a team development environment. It supports
deploying the application in different environments., (*3)
Documentation is at docs/guide/README.md., (*4)
, (*5)
HOW IS THIS DIFFERENT FROM STANDARD ADVANCED APP?
- This project can be deployed by Deployer
- An
.htaccess is added to the frontend/web and backend/web folders and FollowSymlinks is turned on.
- Init script has been removed because Deployer configures the project according to the values in
deployer/stage/servers.yml.
HOW DOES IT WORK?
See my blog post Deploying Yii with Deployer, (*6)
See also yii2-app-basic-deployer, (*7)
DIRECTORY STRUCTURE
common
config/ contains shared configurations
mail/ contains view files for e-mails
models/ contains model classes used in both backend and frontend
console
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
deployer
recipe/ contains deployer recipes
stage/ contains deployer server configurations
environments/ contains environment based templates
configured by Deployer according to
the values in `deployer/stage/servers.yml`
backend
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
views/ contains view files for the Web application
web/ contains the entry script and Web resources
frontend
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
views/ contains view files for the Web application
web/ contains the entry script and Web resources
widgets/ contains frontend widgets
vendor/ contains dependent 3rd-party packages
tests contains various tests for the advanced application
codeception/ contains tests developed with Codeception PHP Testing Framework
REQUIREMENTS
The minimum requirement by this project template that your Web server supports PHP 5.4.0., (*8)
Deployer
mv deployer.phar /usr/local/bin/dep
chmod +x /usr/local/bin/dep
For more, see Deployer - Installation, (*9)
INSTALLATION
Install via Composer
If you do not have Composer, you may install it by following the instructions
at getcomposer.org., (*10)
You can then install this project template using the following command:, (*11)
php composer.phar global require "fxp/composer-asset-plugin:~1.1.1"
php composer.phar create-project --prefer-dist --stability=dev jacmoe/yii2-app-advanced-deployer advanced
Deployment
servers.yml
First, create a file entitled servers.yml in the deployer/stage directory.
You can copy the contents of servers-sample.yml to get you started., (*12)
Create db on server
Prior to deployment, make sure that you have created a database on the server you want to deploy to., (*13)
deploy command
When you have created a server configuration file, all you need to do is run this command:, (*14)
dep deploy production
or, (*15)
dep deploy local
Note that the server configuration for the local stage needs to have a key called local because that will make Deployer create a local server that doesn't use ssh.
If the active stage does not have local set for the server, you need an ssh server on your local machine (sudo apt-get install openssh-server)., (*16)
It is very common to serve the project in place when developing, and therefore this project template ships with a function to configure files, set writable directories and install vendors., (*17)
Simply run:, (*18)
dep inplace local
This command assumes that you've set the deploy dir in the servers.yml configuration file to point to your current source directory (the directory you are in)., (*19)
Wallogit.com
