jacmoe/yii2-app-basic-zurbified

Yii 2 Basic Gulp Sass Application Template using Zurb Foundation for Sites

Yii 2 Basic Gulp Sass Application Template using Zurb Foundation for Sites

Yii 2 Basic Gulp Sass Application Template using Zurb Foundation for Sites is a skeleton Yii 2 application that adds support for Gulp and Sass., _(*1)

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., _(*2)

, _(*3)

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., _(*4)

INSTALLATION

Prerequisites

Before you start, make sure you have installed composer and Node.js. If you are on Debian or Ubuntu you might also want to install the libnotify-bin package, which is used by Gulp to inform you about its status., _(*5)

Gulp

install gulp globally if you haven't done so before, _(*6)

npm install -g gulp-cli

Browsersync

install browsersync globally if you haven't done so before, _(*7)

npm install -g browser-sync

Install via Composer

If you do not have Composer, you may install it by following the instructions at getcomposer.org., _(*8)

You can then install this project template using the following command:, _(*9)

php composer.phar global require "fxp/composer-asset-plugin:~1.1.1"
php composer.phar create-project --prefer-dist --stability=dev jacmoe/yii2-app-basic-zurbified basiczurb

Post-installation

Install the node modules by running this command at the project root directory:, _(*10)

npm install

After a successful install, build the project using:, _(*11)

gulp build

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

http://localhost/basic/web/

To launch a browser window and watch the project for changes:, _(*13)

gulp

To build optimized for production (minification, etc) specify the production flag:, _(*14)

gulp build --production

and/or, _(*15)

gulp --production

CONFIGURATION

Database

Edit the file config/db.php with real data, for example:, _(*16)

return [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=localhost;dbname=yii2basic',
    '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. - Refer to the README in the tests directory for information specific to basic application tests., _(*17)