init

{

    "directory" : "vendor/bower-asset"

}

# phpstorm project files

.idea

# netbeans project files

nbproject

# zend studio for eclipse project files

.buildpath

.project

.settings

# windows thumbnail cache

Thumbs.db

# composer vendor dir

/vendor

# composer itself is not needed

composer.phar

# composer lock

composer.lock

# Mac DS_Store Files

.DS_Store

# phpunit itself is not needed

phpunit.phar

# local phpunit config

/phpunit.xml

tests/_output/*

tests/_support/_generated

#vagrant folder

/.vagrant

 No newline at end of file

Copyright © 2008 by Yii Software LLC (http://www.yiisoft.com)

All rights reserved.

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions

are met:

 * Redistributions of source code must retain the above copyright

   notice, this list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright

   notice, this list of conditions and the following disclaimer in

   the documentation and/or other materials provided with the

   distribution.

 * Neither the name of Yii Software LLC nor the names of its

   contributors may be used to endorse or promote products derived

   from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS

FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE

COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,

INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,

BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

POSSIBILITY OF SUCH DAMAGE.

<p align="center">

    <a href="https://github.com/yiisoft" target="_blank">

        <img src="https://avatars0.githubusercontent.com/u/993323" height="100px">

    </a>

    <h1 align="center">Yii 2 Basic Project Template</h1>

    <br>

</p>

Yii 2 Basic Project Template is a skeleton [Yii 2](http://www.yiiframework.com/) application best for

rapidly creating small projects.

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](https://img.shields.io/packagist/v/yiisoft/yii2-app-basic.svg)](https://packagist.org/packages/yiisoft/yii2-app-basic)

[![Total Downloads](https://img.shields.io/packagist/dt/yiisoft/yii2-app-basic.svg)](https://packagist.org/packages/yiisoft/yii2-app-basic)

[![build](https://github.com/yiisoft/yii2-app-basic/workflows/build/badge.svg)](https://github.com/yiisoft/yii2-app-basic/actions?query=workflow%3Abuild)

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 7.4.

INSTALLATION

------------

### Install via Composer

If you do not have [Composer](http://getcomposer.org/), you may install it by following the instructions

at [getcomposer.org](http://getcomposer.org/doc/00-intro.md#installation-nix).

You can then install this project template using the following command:

~~~

composer create-project --prefer-dist yiisoft/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/

~~~

### Install from an Archive File

Extract the archive file downloaded from [yiiframework.com](http://www.yiiframework.com/download/) 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:

```php

'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/basic/web/

~~~

### Install with Docker

Update your vendor packages

    docker-compose run --rm php composer update --prefer-dist

Run the installation triggers (creating cookie validation code)

    docker-compose run --rm php composer install    

Start the container

    docker-compose up -d

You can then access the application through the following URL:

    http://127.0.0.1:8000

**NOTES:** 

- Minimum required Docker engine version `17.04` for development (see [Performance tuning for volume mounts](https://docs.docker.com/docker-for-mac/osxfs-caching/))

- The default configuration uses a host-volume in your home directory `.docker-composer` for composer caches

CONFIGURATION

-------------

### Database

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

```php

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.

TESTING

-------

Tests are located in `tests` directory. They are developed with [Codeception PHP Testing Framework](http://codeception.com/).

By default, there are 3 test suites:

- `unit`

- `functional`

- `acceptance`

Tests can be executed by running

```

vendor/bin/codecept run

```

The command above will execute unit and functional tests. Unit tests are testing the system components, while functional

tests are for testing user interaction. Acceptance tests are disabled by default as they require additional setup since

they perform testing in real browser. 

### Running  acceptance tests

To execute acceptance tests do the following:  

1. Rename `tests/acceptance.suite.yml.example` to `tests/acceptance.suite.yml` to enable suite configuration

2. Replace `codeception/base` package in `composer.json` with `codeception/codeception` to install full-featured

   version of Codeception

3. Update dependencies with Composer 

    ```

    composer update  

    ```

4. Download [Selenium Server](http://www.seleniumhq.org/download/) and launch it:

    ```

    java -jar ~/selenium-server-standalone-x.xx.x.jar

    ```

    In case of using Selenium Server 3.0 with Firefox browser since v48 or Google Chrome since v53 you must download [GeckoDriver](https://github.com/mozilla/geckodriver/releases) or [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) and launch Selenium with it:

    ```

    # for Firefox

    java -jar -Dwebdriver.gecko.driver=~/geckodriver ~/selenium-server-standalone-3.xx.x.jar

    # for Google Chrome

    java -jar -Dwebdriver.chrome.driver=~/chromedriver ~/selenium-server-standalone-3.xx.x.jar

    ``` 

    As an alternative way you can use already configured Docker container with older versions of Selenium and Firefox:

    ```

    docker run --net=host selenium/standalone-firefox:2.53.0

    ```

5. (Optional) Create `yii2basic_test` database and update it by applying migrations if you have them.

   ```

   tests/bin/yii migrate

   ```

   The database configuration can be found at `config/test_db.php`.

6. Start web server:

    ```

    tests/bin/yii serve

    ```

7. Now you can run all available tests

   ```

   # run all available tests

   vendor/bin/codecept run

   # run acceptance tests

   vendor/bin/codecept run acceptance

   # run only unit and functional tests

   vendor/bin/codecept run unit,functional

   ```

### Code coverage support

By default, code coverage is disabled in `codeception.yml` configuration file, you should uncomment needed rows to be able

to collect code coverage. You can run your tests and collect coverage with the following command:

```

#collect coverage for all tests

vendor/bin/codecept run --coverage --coverage-html --coverage-xml

#collect coverage only for unit tests

vendor/bin/codecept run unit --coverage --coverage-html --coverage-xml

#collect coverage for unit and functional tests

vendor/bin/codecept run functional,unit --coverage --coverage-html --coverage-xml

```

You can see code coverage output under the `tests/_output` directory.

require 'yaml'

require 'fileutils'

required_plugins_installed = nil

required_plugins = %w( vagrant-hostmanager vagrant-vbguest )

required_plugins.each do |plugin|

  unless Vagrant.has_plugin? plugin

    system "vagrant plugin install #{plugin}"

    required_plugins_installed = true

  end

end

# IF plugin[s] was just installed - restart required

if required_plugins_installed

  # Get CLI command[s] and call again

  system 'vagrant' + ARGV.to_s.gsub(/\[\"|\", \"|\"\]/, ' ')

  exit

end

domains = {

  app: 'yii2basic.test'

}

vagrantfile_dir_path = File.dirname(__FILE__)

config = {

  local: vagrantfile_dir_path + '/vagrant/config/vagrant-local.yml',

  example: vagrantfile_dir_path + '/vagrant/config/vagrant-local.example.yml'

}

# copy config from example if local config not exists

FileUtils.cp config[:example], config[:local] unless File.exist?(config[:local])

# read config

options = YAML.load_file config[:local]

# check github token

if options['github_token'].nil? || options['github_token'].to_s.length != 40

  puts "You must place REAL GitHub token into configuration:\n/yii2-app-basic/vagrant/config/vagrant-local.yml"

  exit

end

# vagrant configurate

Vagrant.configure(2) do |config|

  # select the box

  config.vm.box = 'bento/ubuntu-18.04'

  # should we ask about box updates?

  config.vm.box_check_update = options['box_check_update']

  config.vm.provider 'virtualbox' do |vb|

    # machine cpus count

    vb.cpus = options['cpus']

    # machine memory size

    vb.memory = options['memory']

    # machine name (for VirtualBox UI)

    vb.name = options['machine_name']

  end

  # machine name (for vagrant console)

  config.vm.define options['machine_name']

  # machine name (for guest machine console)

  config.vm.hostname = options['machine_name']

  # network settings

  config.vm.network 'private_network', ip: options['ip']

  # sync: folder 'yii2-app-advanced' (host machine) -> folder '/app' (guest machine)

  config.vm.synced_folder './', '/app', owner: 'vagrant', group: 'vagrant'

  # disable folder '/vagrant' (guest machine)

  config.vm.synced_folder '.', '/vagrant', disabled: true

  # hosts settings (host machine)

  config.vm.provision :hostmanager

  config.hostmanager.enabled            = true

  config.hostmanager.manage_host        = true

  config.hostmanager.ignore_private_ip  = false

  config.hostmanager.include_offline    = true

  config.hostmanager.aliases            = domains.values

  # quick fix for failed guest additions installations

  # config.vbguest.auto_update = false

  # provisioners

  config.vm.provision 'shell', path: './vagrant/provision/once-as-root.sh', args: [options['timezone'], options['ip']]

  config.vm.provision 'shell', path: './vagrant/provision/once-as-vagrant.sh', args: [options['github_token']], privileged: false

  config.vm.provision 'shell', path: './vagrant/provision/always-as-root.sh', run: 'always'

  # post-install message (vagrant console)

  config.vm.post_up_message = "App URL: http://#{domains[:app]}"

end