A Yii 2 Application Template For Purists
The main tenet of this template is: Keep it simple! The idea was to only include the absolutely necessary features - and optimize some of the configuration issues of the original Yii2 base template.
- Very flat configuration file structure
- Provide local configuration files that won't get committed
YII_ENVto configuration files
- SiteController with login, logout, signup and password forget actions
All configuration lives in 4 (or 5) files in the
web.phpconfiguration of the web app
local.phplocal overrides to the web config. This file is not committed.
console.phpconfiguration of the console. Here you can reuse parts of the merged
local.phpconfiguration. See the example file for how this works.
params.phpapplication parameters for both web and console application
console-local.phpan optional file with local overrides to the console configuration. This file is not committed.
Before you can create new applications on a host, you first have to install the composer asset plugin:
composer global require "fxp/composer-asset-plugin:1.0.0-beta2"
To create a new application you will usually follow this workflow:
- Install the template with
composer create-project --prefer-dist --stability=dev mikehaertl/yii2-base-app .
- Add optional dependencies to
- Add local configuration to
config/console.phpand add project wide configuration
migrations/m140328_144900_initto suit your user table schema.
- Check the models in
models/and add/remove attributes.
- Run migrations with
This should get you started. Your app should now run in a base version and is ready to be committed to your project repository.
Note: After the
composer create-commandstep a unique cookie validation key is automatically generated and added to
composer updateabove may fail with an error about github rate limit exceeded. Have a look here for how to resolve this issue.
To keep this template updated with the latest package version, we should run
from time to time and then commit