README.md 2.46 KB
Newer Older
1 2
Yii 2 Basic Application Template
================================
3

4
**NOTE** Yii 2 and the relevant applications and extensions are still under heavy
5 6
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)
7
if you have a project to be deployed for production soon.
8 9


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

13
Yii 2 Basic Application Template is best suitable for small Websites which mainly contain
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
a few informational pages.


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

      commands/           contains console commands (controllers)
      config/             contains application configurations
      controllers/        contains Web controller classes
      models/             contains model classes
      runtime/            contains files generated during runtime
      vendor/             contains dependent 3rd-party packages
      views/              contains view files for the Web application
      www/                contains the entry script and Web resources



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

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


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

40
### Install via Composer
41

42 43 44 45 46 47 48 49 50 51
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
~~~

You can then install the Bootstrap Application using the following command:

~~~
52
php composer.phar create-project --stability=dev yiisoft/yii2-app-basic yii-basic
53 54
~~~

55
Now you should be able to access the application using the URL `http://localhost/yii-basic/www/`,
56
assuming `yii-basic` is directly under the document root of your Web server.
57 58 59 60 61


### Install from an Archive File

This is not currently available. We will provide it when Yii 2 is formally released.
Tobias Munk committed
62 63 64 65


### Install from development repository

66
If you've cloned the [Yii 2 framework main development repository](https://github.com/yiisoft/yii2) you
Tobias Munk committed
67 68 69 70 71 72 73 74 75
can bootstrap your application with:

~~~
cd yii2/apps/basic
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
76
from local packages.*