hscstudio/yii2-app-workshop

Yii 2 Workshop Project Template

v1.0.0 2015-11-15 18:53 UTC

Requires

• php: >=5.4.0
• hscstudio/yii2-export: ~1.0
• hscstudio/yii2-mimin: ~1.0
• kartik-v/yii2-widgets: ~3.4
• yiisoft/yii2: >=2.0.5
• yiisoft/yii2-bootstrap: *
• yiisoft/yii2-swiftmailer: *

Requires (Dev)

• yiisoft/yii2-codeception: *
• yiisoft/yii2-debug: *
• yiisoft/yii2-faker: *
• yiisoft/yii2-gii: *

BSD-3-Clause

• framework
• yii2
• project template
• workshop

README

Yii 2 Workshop Project Template is a skeleton Yii 2 application best for rapidly creating small projects.

The template is single with more extension for workshop purpose. It includes all commonly used configurations that would allow you to focus on adding new features to your application.

DIRECTORY STRUCTURE

  assets/             contains assets definition
  commands/           contains console commands (controllers)
  config/             contains application configurations
  controllers/        contains Web controller classes
  mail/               contains view files for e-mails
  migrations/         contains database migrations
  models/             contains model classes
  runtime/            contains files generated during runtime
  tests/              contains various tests for the basic application
  vendor/             contains dependent 3rd-party packages
  views/              contains view files for the Web application
  web/                contains the entry script and Web resources

REQUIREMENTS

The minimum requirement by this project template that your Web server supports PHP 5.4.0.

INSTALLATION

Install from an Archive File

Extract the archive file downloaded from yiiframework.com to a directory named basic that is directly under the Web root.

Set cookie validation key in config/web.php file to some random secret string:

'request' => [
    // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
    'cookieValidationKey' => '<secret random string goes here>',
],

You can then access the application through the following URL:

http://localhost/single/web/

Install via Composer

If you do not have Composer, you may install it by following the instructions at getcomposer.org.

You can then install this project template using the following command:

php composer.phar global require "fxp/composer-asset-plugin:~1.1.0"
php composer.phar create-project --prefer-dist --stability=dev hscstudio/yii2-app-workshop workshop

CONFIGURATION

Database

Create a new database and adjust the components['db'] configuration the file config/db.php with real data, for example:

return [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=localhost;dbname=yii2workshop',
    'username' => 'root',
    'password' => '1234',
    'charset' => 'utf8',
];

Apply migrations with console command

yii migrate

Now you should be able to access the application through the following URL, assuming workshop is the directory directly under the Web root.

http://localhost/workshop/web/

NOTES:

• Check and edit the other files in the config/ directory to customize your application as required.
• Refer to the README in the tests direcotry for information specific to basic application tests.