frixou89/yii2-basic-app-dotenv

Yii 2 Basic Project Template with dotenv support

dev-master 2017-10-23 07:13 UTC

Requires

• php: >=5.4.0
• trntv/cheatsheet: ^0.1@dev
• vlucas/phpdotenv: ^2.4
• yiisoft/yii2: ~2.0.5
• yiisoft/yii2-bootstrap: ~2.0.0
• yiisoft/yii2-swiftmailer: ~2.0.0

Requires (Dev)

• codeception/base: ^2.2.3
• codeception/specify: ~0.4.3
• codeception/verify: ~0.3.1
• yiisoft/yii2-debug: ~2.0.0
• yiisoft/yii2-faker: ~2.0.0
• yiisoft/yii2-gii: ~2.0.0

BSD-3-Clause

• framework
• basic
• dotenv
• yii2
• project template

README

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. This template also removes the basic/web from the url.

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

REQUIREMENTS

The minimum requirement by this project 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 project template using the following command:

php composer.phar global require "fxp/composer-asset-plugin:^1.2.0"
php composer.phar create-project --prefer-dist --stability=dev frixou89/yii2-basic-app-dotenv 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/

Install from an Archive File

Download and extract the archive file 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/

CONFIGURATION

Copy .env.dist and rename it to .env

Database

Edit the .env file with real data, for example:

Migration

To create user table you need to run Yii migrate from the root directory

php yii migrate