yiisoft/yii-base-web

Yii Framework Web Application Base

dev-master / 3.0.x-dev 2019-07-17 12:26 UTC

README

Yii Framework

Yii Framework Application


This package is one of the three Yii Framework application bases provided for rapidly creating projects.

This template is still experimental and provided to help you discover Yii 3. If you are looking to develop with the last stable Yii version, use yii2-app-basic instead

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.

Latest Stable Version Total Downloads Build Status

DIRECTORY STRUCTURE

bin/
config/             contains application configurations
public/             contains the entry script for a web server
runtime/            contains files generated during runtime
src/
  assets/             contains assets definition
  commands/           contains console commands (controllers)
  controllers/        contains Web controller classes
  mail/               contains view files for e-mails
  messages/           contains translations files
  models/             contains model classes
  views/              contains view files for the Web application
  widgets/            contains Widgets
vendor/             contains dependent 3rd-party packages
.env
.env.dist
composer.json

REQUIREMENTS

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

INSTALLATION

Follow the installation of yii-project-template to get started with this template.

CONFIGURATION

You should recreate configuration files as needed in your root config/ directory.

Make sure they are listed in the extra.config-plugin entry of your composer.json file in order for them to be discovered, and remember to run composer dump-autoload (or composer du) every time you change a configuration value.

Refer to hiqdev/composer-config-plugin for more information.

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.