Blame view

app/README.md 2.64 KB
bf807468   Alex Savenko   first commit
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
  Yii 2 Basic Application Template
  ================================
  
  Yii 2 Basic Application Template is a skeleton Yii 2 application best for
  rapidly creating small projects.
  
  The template contains the basic features including user login/logout and a contact page.
  It includes all commonly used configurations that would allow you to focus on adding new
  features to your application.
  
  
  DIRECTORY STRUCTURE
  -------------------
  
        assets/             contains assets definition
        commands/           contains console commands (controllers)
        config/             contains application configurations
        controllers/        contains Web controller classes
        mail/               contains view files for e-mails
        models/             contains model classes
        runtime/            contains files generated during runtime
        tests/              contains various tests for the basic application
        vendor/             contains dependent 3rd-party packages
        views/              contains view files for the Web application
        web/                contains the entry script and Web resources
  
  
  
  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 `basic` that is directly under the Web root.
  
  You can then access the application through the following URL:
  
  ~~~
  http://localhost/basic/web/
  ~~~
  
  
  ### 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 this application template 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-basic basic
  ~~~
  
  Now you should be able to access the application through the following URL, assuming `basic` is the directory
  directly under the Web root.
  
  ~~~
  http://localhost/basic/web/
  ~~~
  
  
  CONFIGURATION
  -------------
  
  ### Database
  
  Edit the file `config/db.php` with real data, for example:
  
  ```php
  return [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host=localhost;dbname=yii2basic',
      'username' => 'root',
      'password' => '1234',
      'charset' => 'utf8',
  ];
  ```
  
  **NOTE:** Yii won't create the database for you, this has to be done manually before you can access it.
  
  Also check and edit the other files in the `config/` directory to customize your application.