Blame view

README.md 4.02 KB
c7f222e2   Artem   first
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
  Yii 2 Advanced Application Template
  ===================================
  
  Yii 2 Advanced Application Template 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. It supports
  deploying the application in different environments.
  
  
  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
  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
  environments/            contains environment-based overrides
  tests                    contains various tests for the advanced application
      codeception/         contains tests developed with Codeception PHP Testing Framework
  ```
  
  
  REQUIREMENTS
  ------------
  
  The minimum requirement by this application template that your Web server supports PHP 5.4.0.
  
  
  INSTALLATION
  ------------
  
  ### Install from an Archive File
  
  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.
  
  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).
  
  You can then install the application using the following command:
  
  ~~~
  php composer.phar global require "fxp/composer-asset-plugin:1.0.0-beta4"
  php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-advanced advanced
  ~~~
  
  
  GETTING STARTED
  ---------------
  
  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.
  
  1. Run command `init` to initialize the application with a specific environment.
  2. Create a new database and adjust the `components['db']` configuration in `common/config/main-local.php` accordingly.
  3. Apply migrations with console command `yii migrate`. This will create tables needed for the application to work.
  4. Set document roots of your Web server:
  
  - 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/`
  
  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.