yii2-netdisk/README.md

89 lines
2.6 KiB
Markdown
Raw Normal View History

2013-05-24 22:14:49 +08:00
Yii 2 Basic Application Template
================================
2013-12-02 01:17:58 +08:00
Yii 2 Basic Application Template is a skeleton Yii 2 application best for
rapidly developing small Websites containing mainly informational pages.
2013-05-24 22:14:49 +08:00
2013-12-02 01:17:58 +08:00
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.
2013-05-24 22:14:49 +08:00
DIRECTORY STRUCTURE
-------------------
assets/ contains assets definition
2013-05-24 22:14:49 +08:00
commands/ contains console commands (controllers)
config/ contains application configurations
controllers/ contains Web controller classes
mails/ contains view files for e-mails
2013-05-24 22:14:49 +08:00
models/ contains model classes
runtime/ contains files generated during runtime
tests/ contains various tests for the basic application
2013-05-24 22:14:49 +08:00
vendor/ contains dependent 3rd-party packages
views/ contains view files for the Web application
2013-07-25 19:57:49 +08:00
web/ contains the entry script and Web resources
2013-05-24 22:14:49 +08:00
REQUIREMENTS
------------
2013-12-02 01:17:58 +08:00
The minimum requirement by this application template that your Web server supports PHP 5.4.0.
2013-05-24 22:14:49 +08:00
INSTALLATION
------------
2013-12-02 01:17:58 +08:00
### Install from an Archive File
2013-05-24 22:14:49 +08:00
2013-12-02 01:17:58 +08:00
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.
2013-05-24 22:14:49 +08:00
2013-12-02 01:17:58 +08:00
You can then access the application through the following URL:
2013-05-24 22:14:49 +08:00
~~~
2013-12-02 01:17:58 +08:00
http://localhost/basic/web/
2013-05-24 22:14:49 +08:00
~~~
2013-12-02 01:17:58 +08:00
### Install via Composer
2013-05-24 22:14:49 +08:00
2013-12-02 01:17:58 +08:00
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).
2013-12-02 01:17:58 +08:00
You can then install this application template using the following command:
2013-12-02 01:17:58 +08:00
~~~
php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-basic basic
2013-12-02 01:17:58 +08:00
~~~
2013-12-02 01:17:58 +08:00
Now you should be able to access the application through the following URL, assuming `basic` is the directory
directly under the Web root.
~~~
2013-12-02 01:17:58 +08:00
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.