PHPackages                             jacksontong/yii2-app-basic-docker-gulp-sass - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. jacksontong/yii2-app-basic-docker-gulp-sass

ActiveProject[Framework](/categories/framework)

jacksontong/yii2-app-basic-docker-gulp-sass
===========================================

Yii 2 Basic Project Template with Docker, Gulp and Sass support

2.0.12(8y ago)02BSD-3-ClausePHPPHP &gt;=5.4.0

Since Oct 10Pushed 8y ago2 watchersCompare

[ Source](https://github.com/jacksontong/yii2-app-basic-docker-gulp-sass)[ Packagist](https://packagist.org/packages/jacksontong/yii2-app-basic-docker-gulp-sass)[ Docs](http://www.yiiframework.com/)[ RSS](/packages/jacksontong-yii2-app-basic-docker-gulp-sass/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (10)Versions (2)Used By (0)

Yii 2 Basic Project Template
============================

[](#yii-2-basic-project-template)

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://camo.githubusercontent.com/1110e9d4bed6fcb6a0d6c66c27d9da80543782429b09edfa5741f9c665291eac/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f796969322d6170702d62617369632f762f737461626c652e706e67)](https://packagist.org/packages/yiisoft/yii2-app-basic)[![Total Downloads](https://camo.githubusercontent.com/f49d6ffe358944e26e9c33ba4ce1bd3b1ad26c3ee7282fcd8a58cfe27bce71e6/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f796969322d6170702d62617369632f646f776e6c6f6164732e706e67)](https://packagist.org/packages/yiisoft/yii2-app-basic)[![Build Status](https://camo.githubusercontent.com/f32bf420859a803755af4f5c4ad3cbb167c986c8b044c948708f16e8ad26c50f/68747470733a2f2f7472617669732d63692e6f72672f796969736f66742f796969322d6170702d62617369632e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/yiisoft/yii2-app-basic)

DIRECTORY STRUCTURE
-------------------

[](#directory-structure)

```
  assets/             contains assets definition
  commands/           contains console commands (controllers)
  config/             contains application configurations
  controllers/        contains Web controller classes
  docker/             contains Dockerfiles
  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
------------

[](#requirements)

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

INSTALLATION
------------

[](#installation)

### Gulp

[](#gulp)

install gulp globally if you haven't done so before

```
npm install -g gulp-cli

```

### Install via Composer

[](#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:

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

[](#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:

```
'request' => [
    // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
    'cookieValidationKey' => '',
],
```

You can then access the application through the following URL:

```
http://localhost/basic/web/

```

### Run from Docker

[](#run-from-docker)

```
npm start
```

```
cp .env-example .env
docker-compose up
```

```
// port number from .env file
http://localhost:[NGINX_EXPOSE_PORT]

```

CONFIGURATION
-------------

[](#configuration)

### Database

[](#database)

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

```
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
-------

[](#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

[](#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

    ```
5. (Optional) Create `yii2_basic_tests` 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

[](#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-html --coverage-xml

#collect coverage only for unit tests
vendor/bin/codecept run unit -- --coverage-html --coverage-xml

#collect coverage for unit and functional tests
vendor/bin/codecept run functional,unit -- --coverage-html --coverage-xml

```

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

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity2

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3136d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/cb501059287b6ebe3dbc121fc8f2242e80b8f3fdf7883f157a9e05e1892fc8f3?d=identicon)[tongtoanbs](/maintainers/tongtoanbs)

---

Top Contributors

[![jacksontong](https://avatars.githubusercontent.com/u/7871218?v=4)](https://github.com/jacksontong "jacksontong (23 commits)")

---

Tags

frameworkyii2project templatebasic

### Embed Badge

![Health badge](/badges/jacksontong-yii2-app-basic-docker-gulp-sass/health.svg)

```
[![Health](https://phpackages.com/badges/jacksontong-yii2-app-basic-docker-gulp-sass/health.svg)](https://phpackages.com/packages/jacksontong-yii2-app-basic-docker-gulp-sass)
```

###  Alternatives

[yii2mod/base

Base application template for Yii2

531.3k](/packages/yii2mod-base)[developeruz/yii-vue-app

Yii 2 + Vue.js Basic Project Template

1221.6k](/packages/developeruz-yii-vue-app)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
