mirror of
https://github.com/yiisoft/yii2.git
synced 2025-08-19 01:34:44 +08:00
Reorganized application template docs structure
This commit is contained in:
3
docs/guide/apps-advanced.md
Normal file
3
docs/guide/apps-advanced.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Advanced application template
|
||||||
|
=============================
|
||||||
|
|
6
docs/guide/apps-basic.md
Normal file
6
docs/guide/apps-basic.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
Basic application template
|
||||||
|
==========================
|
||||||
|
|
||||||
|
The application has four pages: the homepage, the about page, the contact page and the login page.
|
||||||
|
The contact page displays a contact form that users can fill in to submit their inquiries to the webmaster,
|
||||||
|
and the login page allows users to be authenticated before accessing privileged contents.
|
@ -1,69 +0,0 @@
|
|||||||
Bootstrap with Yii
|
|
||||||
==================
|
|
||||||
|
|
||||||
Yii provides a few ready-to-use application templates. Based on your needs, you may
|
|
||||||
choose one of them to bootstrap your project.
|
|
||||||
|
|
||||||
In the following, we describe how to get started with the "Yii 2 Basic Application Template".
|
|
||||||
|
|
||||||
|
|
||||||
### 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
|
|
||||||
~~~
|
|
||||||
|
|
||||||
You can then install the Bootstrap Application using the following command:
|
|
||||||
|
|
||||||
~~~
|
|
||||||
php composer.phar create-project --stability=dev yiisoft/yii2-app-basic yii-basic
|
|
||||||
~~~
|
|
||||||
|
|
||||||
Now you should be able to access the Bootstrap Application using the URL `http://localhost/yii-basic/web/`,
|
|
||||||
assuming `yii-basic` is directly under the document root of your Web server.
|
|
||||||
|
|
||||||
|
|
||||||
As you can see, the application has four pages: the homepage, the about page,
|
|
||||||
the contact page and the login page. The contact page displays a contact
|
|
||||||
form that users can fill in to submit their inquiries to the webmaster,
|
|
||||||
and the login page allows users to be authenticated before accessing privileged contents.
|
|
||||||
|
|
||||||
|
|
||||||
The following diagram shows the directory structure of this application.
|
|
||||||
|
|
||||||
~~~
|
|
||||||
yii-basic/
|
|
||||||
yii yii command line script for Unix/Linux
|
|
||||||
yii.bat yii command line script for Windows
|
|
||||||
requirements.php the requirement checker script
|
|
||||||
commands/ containing customized yii console commands
|
|
||||||
config/ containing configuration files
|
|
||||||
console.php the console application configuration
|
|
||||||
main.php the Web application configuration
|
|
||||||
controllers/ containing controller class files
|
|
||||||
SiteController.php the default controller class
|
|
||||||
vendor/ containing third-party extensions and libraries
|
|
||||||
models/ containing model class files
|
|
||||||
User.php the User model
|
|
||||||
LoginForm.php the form model for 'login' action
|
|
||||||
ContactForm.php the form model for 'contact' action
|
|
||||||
runtime/ containing temporarily generated files
|
|
||||||
views/ containing controller view and layout files
|
|
||||||
layouts/ containing layout view files
|
|
||||||
main.php the base layout shared by all pages
|
|
||||||
site/ containing view files for the 'site' controller
|
|
||||||
about.php the view for the 'about' action
|
|
||||||
contact.php the view for the 'contact' action
|
|
||||||
index.php the view for the 'index' action
|
|
||||||
login.php the view for the 'login' action
|
|
||||||
web/ containing Web-accessible resources
|
|
||||||
index.php Web application entry script file
|
|
||||||
assets/ containing published resource files
|
|
||||||
css/ containing CSS files
|
|
||||||
~~~
|
|
||||||
|
|
||||||
|
|
||||||
TBD
|
|
@ -7,9 +7,15 @@ Getting started
|
|||||||
===============
|
===============
|
||||||
|
|
||||||
- [Installation](installation.md)
|
- [Installation](installation.md)
|
||||||
- [Bootstrap with Yii](bootstrap.md)
|
|
||||||
- [Configuration](configuration.md)
|
- [Configuration](configuration.md)
|
||||||
|
|
||||||
|
Application templates
|
||||||
|
=====================
|
||||||
|
|
||||||
|
- [Basic](apps-basic.md)
|
||||||
|
- [Advanced](apps-advanced.md)
|
||||||
|
- [Creating your own application template](apps-own.md)
|
||||||
|
|
||||||
Base concepts
|
Base concepts
|
||||||
=============
|
=============
|
||||||
|
|
||||||
@ -57,13 +63,6 @@ Toolbox
|
|||||||
- [Error Handling](error.md)
|
- [Error Handling](error.md)
|
||||||
- [Logging](logging.md)
|
- [Logging](logging.md)
|
||||||
|
|
||||||
Application templates
|
|
||||||
=====================
|
|
||||||
|
|
||||||
- [Basic](application-basic.md)
|
|
||||||
- [Advanced](application-advanced.md)
|
|
||||||
- [Creating your own application template](application-own.md)
|
|
||||||
|
|
||||||
More
|
More
|
||||||
====
|
====
|
||||||
|
|
||||||
|
@ -4,7 +4,15 @@ Installation
|
|||||||
Installing via Composer
|
Installing via Composer
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
The recommended way of installing Yii is by using Composer package manager.
|
The recommended way of installing Yii is by using [Composer](http://getcomposer.org/) package manager. If you do not
|
||||||
|
have it, you may download it from [http://getcomposer.org/](http://getcomposer.org/) or run the following command:
|
||||||
|
|
||||||
|
```
|
||||||
|
curl -s http://getcomposer.org/installer | php
|
||||||
|
```
|
||||||
|
|
||||||
|
Yii provides a few ready-to-use application templates. Based on your needs, you may choose one of them to bootstrap
|
||||||
|
your project.
|
||||||
|
|
||||||
There are two application templates available:
|
There are two application templates available:
|
||||||
|
|
||||||
@ -12,7 +20,8 @@ There are two application templates available:
|
|||||||
- [advanced](https://github.com/yiisoft/yii2-app-advanced) that is a set of frontend, backend, console, common
|
- [advanced](https://github.com/yiisoft/yii2-app-advanced) that is a set of frontend, backend, console, common
|
||||||
(shared code) and environments support.
|
(shared code) and environments support.
|
||||||
|
|
||||||
Please refer to installation instructions on these pages.
|
Please refer to installation instructions on these pages. To read more about ideas behing these application templates and
|
||||||
|
proposed usage refer to [basic application template](apps-basic.md) and [advanced application template](apps-advanced.md).
|
||||||
|
|
||||||
Installing from zip
|
Installing from zip
|
||||||
-------------------
|
-------------------
|
||||||
|
Reference in New Issue
Block a user