henrydewa/yii2-app-basic

Yii 2 Basic Application Template With Ready To Use User Model

dev-master 2015-04-24 18:49 UTC

Requires

• php: >=5.4.0
• yiisoft/yii2: *
• yiisoft/yii2-bootstrap: *
• yiisoft/yii2-swiftmailer: *

Requires (Dev)

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

BSD-3-Clause

• framework
• basic
• application template
• yii2

README

Yii 2 Basic Application Template is a skeleton Yii 2 application best for rapidly creating small projects and ready to use User Model.

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.

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
  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
  widgets/            contains the entry script and Web resources

REQUIREMENTS

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

INSTALLATION

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 application template using the following command:

php composer.phar global require "fxp/composer-asset-plugin:1.0.0"
php composer.phar create-project --prefer-dist --stability=dev henrydewa/yii2-app-basic basic

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

http://localhost/basic/web/

Getting started

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.

1. Edit the file config/db.php with real data, for example:

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

1. Apply migrations with console command yii migrate.

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.