README

REQUIREMENTS

The minimum requirement by this project template that your Web server supports PHP 7.1.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:

composer create-project --prefer-dist thefx/yii2-app-basic .

Preparing application

After you install the application, you have to conduct the following steps to initialize the installed application. You only need to do these once for all.

Open a console terminal, execute the init command and select dev as environment.
```
/path/to/php-bin/php /path/to/yii-application/init
```
If you automate it with a script you can execute init in non-interactive mode.
```
/path/to/php-bin/php /path/to/yii-application/init --env=Development --overwrite=All --delete=All
```

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

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

Open a console terminal, apply migrations with command /path/to/php-bin/php /path/to/yii-application/yii migrate.

Apply Migrations

php yii migrate --migrationPath=@thefx/user/migrations
php yii migrate --migrationPath=@thefx/pages/migrations
php yii migrate --migrationPath=@thefx/blocks/migrations

You can then access the application through the following URL:

http://localhost/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

Tests can be executed by running

docker-compose run --rm php vendor/bin/codecept run

NOTES:

Minimum required Docker engine version 17.04 for development (see Performance tuning for volume mounts)
The default configuration uses a host-volume in your home directory .docker-composer for composer caches

TESTING

Tests are located in tests directory. They are developed with Codeception PHP Testing Framework. 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.

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.

thefx / yii2-app-basic

Maintainers

Details