README.md 4.02 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
    config/              contains shared configurations
    mail/                contains view files for e-mails
    models/              contains model classes used in both backend and frontend
22
console
23 24 25 26 27
    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
28
backend
29 30 31 32 33 34 35
    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
36
frontend
37 38 39 40 41 42 43 44 45 46 47 48
    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
environments/            contains environment-based overrides
tests                    contains various tests for the advanced application
    codeception/         contains tests developed with Codeception PHP Testing Framework
49 50 51 52 53 54
```


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

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


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

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

Qiang Xue committed
63 64
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.
65

Qiang Xue committed
66 67 68 69 70 71 72
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).
73

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

~~~
Qiang Xue committed
77
php composer.phar global require "fxp/composer-asset-plugin:1.0.0-beta3"
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.