README.md 4.19 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
Yii 2 Advanced Application Template
===================================

**NOTE** Yii 2 and the relevant applications and extensions are still under heavy
development. We may make significant changes without prior notices. Please do not
use them for production. Please consider using [Yii v1.1](https://github.com/yiisoft/yii)
if you have a project to be deployed for production soon.


Thank you for using Yii 2 Advanced Application Template - an application template
that works out-of-box and can be easily customized to fit for your needs.

13
Yii 2 Advanced Application Template is best suitable for large projects requiring frontend and backend separation,
14 15 16 17 18 19 20 21 22
deployment in different environments, configuration nesting etc.


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

```
common
	config/             contains shared configurations
23
	models/             contains model classes used in both backend and frontend
24 25 26 27 28 29
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
30
backend
31
	assets/             contains application assets such as JavaScript and CSS
32
	config/             contains backend configurations
33
	controllers/        contains Web controller classes
34
	models/             contains backend-specific model classes
35 36
	runtime/            contains files generated during runtime
	views/              contains view files for the Web application
37
	web/                contains the entry script and Web resources
38 39 40 41 42 43 44
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
45
	web/                contains the entry script and Web resources
46
vendor/                 contains dependent 3rd-party packages
47
environments/                contains environment-based overrides
48 49 50 51 52 53 54 55 56
```



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

The minimum requirement by Yii is that your Web server supports PHP 5.3.?.

Alexander Makarov committed
57
In order for captcha to work you need either GD2 extension or ImageMagick PHP extension.
58 59 60 61 62 63 64 65 66 67 68 69 70

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

### Install via Composer

If you do not have [Composer](http://getcomposer.org/), you may download it from
[http://getcomposer.org/](http://getcomposer.org/) or run the following command on Linux/Unix/MacOS:

~~~
curl -s http://getcomposer.org/installer | php
~~~

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

~~~
php composer.phar create-project --stability=dev yiisoft/yii2-app-advanced yii-advanced
~~~

77 78
Note that in order to install some dependencies you must have `php_openssl` extension enabled.

79 80 81 82

### Install from an Archive File

This is not currently available. We will provide it when Yii 2 is formally released.
83

Qiang Xue committed
84

Tobias Munk committed
85 86
### Install from development repository

87
If you've cloned the [Yii 2 framework main development repository](https://github.com/yiisoft/yii2) you
Tobias Munk committed
88 89 90 91 92 93 94 95 96 97 98 99
can bootstrap your application with:

~~~
cd yii2/apps/advanced
php composer.phar create-project
~~~

*Note: If the above command fails with `[RuntimeException] Not enough arguments.` run
`php composer.phar self-update` to obtain an updated version of composer which supports creating projects
from local packages.*


100 101 102
GETTING STARTED
---------------

Qiang Xue committed
103 104
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.
105

Qiang Xue committed
106 107 108 109 110 111
1. Execute the `init` command and select `dev` as environment.
2. Create a new database. It is assumed that MySQL InnoDB is used. If not, adjust `console/migrations/m130524_201442_init.php`.
3. In `common/config/params.php` set your database details in `components.db` values.

Now you should be able to access:

112 113
- the frontend using the URL `http://localhost/yii-advanced/frontend/web/`
- the backend using the URL `http://localhost/yii-advanced/backend/web/`
Qiang Xue committed
114 115

assuming `yii-advanced` is directly under the document root of your Web server.
116