samdark/yii2-minimal

Yii 2 minimal Application Template

Fund package maintenance!
samdark
Patreon

Installs: 3 185

Dependents: 0

Suggesters: 0

Security: 0

Stars: 141

Watchers: 11

Forks: 33

Open Issues: 0

Type:project

2.0.5 2021-11-19 21:34 UTC

This package is auto-updated.

Last update: 2024-04-20 03:33:05 UTC


README

Yii 2 Minimal Application Template is a skeleton Yii 2 application best for starting totally from scratch.

The template contains the basic features including user login/logout. It includes all commonly used configurations that would allow you to focus on adding new features to your application.

DIRECTORY STRUCTURE

  commands/           contains console commands (controllers)
  config/             contains application configurations
  controllers/        contains Web controller classes
  models/             contains model classes
  runtime/            contains files generated during runtime
  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 application template that your Web server supports PHP 5.4.0.

INSTALLATION

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:

composer create-project --prefer-dist --stability=dev samdark/yii2-minimal path/to/your/project

Now you should be able to access the application through the following URL, assuming your server webroot is pointed to project/web directory.

http://localhost/

CONFIGURATION

Database

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

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

NOTES:

  • Yii won't create the database for you, this has to be done manually before you can access it.
  • Check and edit the other files in the config/ directory to customize your application as required.