Yii Framework Demo Project

[Yii Framework] is a modern framework designed to be a solid foundation for your PHP application.

It's intended to show and test all Yii features.

Installation

You'll need at least PHP 7.4.

1. Clone this repository.
2. Run composer update in project root directory.
3. Run ./vendor/bin/yii serve (on Windows .\vendor\bin\yii.bat serve). After Application started on http://localhost:8080/
4. Go to index page. Cycle ORM will create tables, indexes and relations automatically in the configured DB. If you want to disable this behavior then comment out line with Generator\SyncTables::class in the config/params.php. In this case you should create migrations to sync changes of entities with DB.
5. Run ./vendor/bin/yii fixture/add 20 to create some random data.

Console

Console works out of the box and could be executed with ./vendor/bin/yii.

Some commands:

user/create <login> <password>
fixture/add [count]

In order to register your own commands, add them to console/params.php, console → commands section.

Web application

In order to run web application either built-in web server could be used by running ./vendor/bin/yii serve or a real web server could be pointed to /public/index.php.

More routes could be added by editing src/Factory/AppRouterFactory.

Testing

The template comes with ready to use Codeception configuration. In order to execute tests run:

composer run serve > ./runtime/yii.log 2>&1 &
vendor/bin/codecept run

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

Support the project

Follow updates

License

The Yii Framework Demo Project is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.