README.md 5.48 KB
Newer Older
1 2 3
Yii 2 Advanced Application Template
===================================

Qiang Xue committed
4 5
Yii 2 Advanced Application Template is a skeleton Yii 2 application best for
developing complex Web applications with multiple tiers.
6

Qiang Xue committed
7 8
The template includes three tiers: front end, back end, and console, each of which
is a separate Yii application.
9

Qiang Xue committed
10 11
The template is designed to work in a team development environment. It supports
deploying the application in different environments.
12 13 14 15 16 17 18


DIRECTORY STRUCTURE
-------------------

```
common
19 20 21 22
	config/				contains shared configurations
	mail/				contains view files for e-mails
	models/				contains model classes used in both backend and frontend
	tests/				contains various tests for objects that are common among applications
23
console
24 25 26 27 28 29
	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
	tests/				contains various tests for the console application
30
backend
31 32 33 34 35 36 37 38
	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
	tests/				contains various tests for the backend application
	views/				contains view files for the Web application
	web/				contains the entry script and Web resources
39
frontend
40 41 42 43 44 45 46 47 48 49
	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
	tests/				contains various tests for the frontend application
	views/				contains view files for the Web application
	web/				contains the entry script and Web resources
vendor/					contains dependent 3rd-party packages
environments/			contains environment-based overrides
50 51 52 53 54 55
```


REQUIREMENTS
------------

Qiang Xue committed
56
The minimum requirement by this application template that your Web server supports PHP 5.4.0.
57 58 59 60 61


INSTALLATION
------------

Qiang Xue committed
62
### Install from an Archive File
63

Qiang Xue committed
64 65
Extract the archive file downloaded from [yiiframework.com](http://www.yiiframework.com/download/) to
a directory named `advanced` that is directly under the Web root.
66

Qiang Xue committed
67 68 69 70 71 72 73
Then follow the instructions given in "GETTING STARTED".


### Install via Composer

If you do not have [Composer](http://getcomposer.org/), you may install it by following the instructions
at [getcomposer.org](http://getcomposer.org/doc/00-intro.md#installation-nix).
74

Qiang Xue committed
75
You can then install the application using the following command:
76 77

~~~
78
php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-advanced advanced
79 80
~~~

Tobias Munk committed
81

82 83 84
GETTING STARTED
---------------

Qiang Xue committed
85 86
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.
87

Qiang Xue committed
88
1. Run command `init` to initialize the application with a specific environment.
Johnny Theill committed
89
2. Create a new database and adjust the `components['db']` configuration in `common/config/main-local.php` accordingly.
Dilip committed
90
3. Apply migrations with console command `yii migrate`. This will create tables needed for the application to work.
91
4. Set document roots of your Web server:
Qiang Xue committed
92

93 94
- for frontend `/path/to/yii-application/frontend/web/` and using the URL `http://frontend/`
- for backend `/path/to/yii-application/backend/web/` and using the URL `http://backend/`
95

Dilip committed
96 97
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.
Mark committed
98 99 100 101

TESTING
-------

Mark committed
102
Install additional composer packages:
Mark committed
103
* `php composer.phar require --dev "codeception/codeception: 1.8.*@dev" "codeception/specify: *" "codeception/verify: *"`
Mark committed
104

Mark committed
105
This application boilerplate use database in testing, so you should create three databases that are used in tests:
Mark committed
106 107
* `yii2_advanced_unit` - database for unit tests;
* `yii2_advanced_functional` - database for functional tests;
Mark committed
108
* `yii2_advanced_acceptance` - database for acceptance tests.
Mark committed
109

110
To make your database up to date, you can run in needed test folder `yii migrate`, for example
Mark committed
111 112 113
if you are starting from `frontend` tests then you should run `yii migrate` in each suite folder `acceptance`, `functional`, `unit`
it will upgrade your database to the last state according migrations.

joseph-kuruvilla committed
114
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/advanced` all you need to is:
Johnny Theill committed
115 116
`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 `/advanced/`.
If you already have a server configured or your application is not located in a folder called `advanced`, you may need to adjust the `TEST_ENTRY_URL` in `frontend/tests/_bootstrap.php` and `backend/tests/_bootstrap.php`.
Mark committed
117 118 119

After that is done you should be able to run your tests, for example to run `frontend` tests do:

120 121 122
* `cd frontend`
* `../vendor/bin/codecept build`
* `../vendor/bin/codecept run`
Mark committed
123 124 125 126

In similar way you can run tests for other application tiers - `backend`, `console`, `common`.

You also can adjust you application suite configs and `_bootstrap.php` settings to use other urls and files, as it is can be done in `yii2-basic`.