Skip to content

Y
yii2
Commit 4e434f1a by Qiang Xue
Options

improved README of apps.

parent 2ca5a845
Showing with 48 additions and 84 deletions
apps/advanced/README.md
Yii 2 Advanced Application Template Yii 2 Advanced Application Template
=================================== ===================================
**NOTE** Yii 2 and the relevant applications and extensions are still under heavy Yii 2 Advanced Application Template is a skeleton Yii 2 application best for
development. We may make significant changes without prior notices. Please do not developing complex Web applications with multiple tiers.
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.
The template includes three tiers: front end, back end, and console, each of which
is a separate Yii application.
Thank you for using Yii 2 Advanced Application Template - an application template The template is designed to work in a team development environment. It supports
that works out-of-box and can be easily customized to fit for your needs. deploying the application in different environments.
Yii 2 Advanced Application Template is best suitable for large projects requiring frontend and backend separation,
deployment in different environments, configuration nesting etc.
DIRECTORY STRUCTURE DIRECTORY STRUCTURE
...@@ -48,61 +45,48 @@ environments/ contains environment-based overrides ...@@ -48,61 +45,48 @@ environments/ contains environment-based overrides
``` ```
REQUIREMENTS REQUIREMENTS
------------ ------------
The minimum requirement by Yii is that your Web server supports PHP 5.4.0. The minimum requirement by this application template that your Web server supports PHP 5.4.0.
In order for captcha to work you need either GD2 extension or ImageMagick PHP extension.
INSTALLATION INSTALLATION
------------ ------------
### Install via Composer ### Install from an Archive File
If you do not have [Composer](http://getcomposer.org/), you may download it from Extract the archive file downloaded from [yiiframework.com](http://www.yiiframework.com/download/) to
[http://getcomposer.org/](http://getcomposer.org/) or run the following command on Linux/Unix/MacOS: a directory named `advanced` that is directly under the Web root.
~~~ Then follow the instructions given in "GETTING STARTED".
curl -s http://getcomposer.org/installer | php
~~~
### 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: You can then install the application using the following command:
~~~ ~~~
php composer.phar create-project --stability=dev yiisoft/yii2-app-advanced yii-advanced php composer.phar create-project --stability=alpha yiisoft/yii2-app-advanced advanced
~~~ ~~~
Note that in order to install some dependencies you must have `php_openssl` extension enabled.
After the application is installed, switch to the project folder and run the following command After the application is installed, switch to the project folder and run the following command
to initialize the application: to initialize the application:
~~~ ~~~
./init (init on Windows) ./init (or "init" on Windows)
~~~ ~~~
You can then access the application through the following URLs,
### Install from an Archive File
This is not currently available. We will provide it when Yii 2 is formally released.
### Install from development repository
If you've cloned the [Yii 2 framework main development repository](https://github.com/yiisoft/yii2) you
can bootstrap your application with:
~~~ ~~~
cd yii2/apps/advanced http://localhost/advanced/frontend/web/
php composer.phar create-project http://localhost/advanced/backend/web/
~~~ ~~~
*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.*
GETTING STARTED GETTING STARTED
--------------- ---------------
...@@ -110,16 +94,11 @@ GETTING STARTED ...@@ -110,16 +94,11 @@ GETTING STARTED
After you install the application, you have to conduct the following steps to initialize 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. the installed application. You only need to do these once for all.
1. Execute the `init` command and select `dev` as environment. Alternatively you can execute it as `init --env=Development` 1. Run command `init` to initialize the application with a specific environment.
or `init --env=Production`. 2. Create a new database and adjust the `components.db` configuration in `common/config/params.php` accordingly.
2. Create a new database. It is assumed that MySQL InnoDB is used. If not, adjust `console/migrations/m130524_201442_init.php`. 3. Run command `yii migrate` to apply DB migrations.
3. In `common/config/params.php` set your database details in `components.db` values.
4. Apply migrations with `yii migrate`.
Now you should be able to access: Now you should be able to access:
- the frontend using the URL `http://localhost/yii-advanced/frontend/web/` - the frontend using the URL `http://localhost/advanced/frontend/web/`
- the backend using the URL `http://localhost/yii-advanced/backend/web/` - the backend using the URL `http://localhost/advanced/backend/web/`
assuming `yii-advanced` is directly under the document root of your Web server.
apps/basic/README.md
Yii 2 Basic Application Template Yii 2 Basic Application Template
================================ ================================
**NOTE** Yii 2 and the relevant applications and extensions are still under heavy Yii 2 Basic Application Template is a skeleton Yii 2 application best for
development. We may make significant changes without prior notices. Please do not rapidly developing small Websites containing mainly informational pages.
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.
The template contains the basic features including user login/logout and a contact page.
Thank you for using Yii 2 Basic Application Template - an application template It includes all commonly used configurations that would allow you to focus on adding new
that works out-of-box and can be easily customized to fit for your needs. features to your application.
Yii 2 Basic Application Template is best suitable for small Websites which mainly contain
a few informational pages.
DIRECTORY STRUCTURE DIRECTORY STRUCTURE
...@@ -31,49 +26,39 @@ DIRECTORY STRUCTURE ...@@ -31,49 +26,39 @@ DIRECTORY STRUCTURE
REQUIREMENTS REQUIREMENTS
------------ ------------
The minimum requirement by Yii is that your Web server supports PHP 5.4.0. The minimum requirement by this application template that your Web server supports PHP 5.4.0.
In order for captcha to work you need either GD2 extension or ImageMagick PHP extension.
INSTALLATION INSTALLATION
------------ ------------
### Install via Composer ### Install from an Archive File
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:
~~~ Extract the archive file downloaded from [yiiframework.com](http://www.yiiframework.com/download/) to
curl -s http://getcomposer.org/installer | php a directory named `basic` that is directly under the Web root.
~~~
You can then install the Bootstrap Application using the following command: You can then access the application through the following URL:
~~~ ~~~
php composer.phar create-project --stability=dev yiisoft/yii2-app-basic yii-basic http://localhost/basic/web/
~~~ ~~~
Now you should be able to access the application using the URL `http://localhost/yii-basic/web/`,
assuming `yii-basic` is directly under the document root of your Web server.
Note that in order to install some dependencies you must have `php_openssl` extension enabled. ### Install via Composer
### Install from an Archive File
This is not currently available. We will provide it when Yii 2 is formally released. 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:
### Install from development repository ~~~
php composer.phar create-project --stability=alpha yiisoft/yii2-app-basic basic
~~~
If you've cloned the [Yii 2 framework main development repository](https://github.com/yiisoft/yii2) you Now you should be able to access the application through the following URL, assuming `basic` is the directory
can bootstrap your application with: directly under the Web root.
~~~ ~~~
cd yii2/apps/basic http://localhost/basic/web/
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.*
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment