yiisoft / app
Yii 3 application template
Fund package maintenance!
Opencollective
yiisoft
Installs: 6 348
Dependents: 0
Suggesters: 0
Security: 0
Stars: 237
Watchers: 31
Forks: 45
Open Issues: 16
Type:project
Requires
- php: ^8.1
- ext-intl: *
- httpsoft/http-message: ^1.1
- psr/container: ^2.0
- psr/http-message: ^1.1|^2.0
- psr/http-server-handler: ^1.0
- symfony/console: ^6.0
- vlucas/phpdotenv: ^5.3
- yiisoft/aliases: ^3.0
- yiisoft/assets: ^4.0
- yiisoft/cache: ^3.0
- yiisoft/cache-file: ^3.0
- yiisoft/config: ^1.1
- yiisoft/csrf: ^2.0
- yiisoft/data-response: ^2.0
- yiisoft/definitions: ^3.0
- yiisoft/di: ^1.2
- yiisoft/error-handler: ^3.0
- yiisoft/factory: ^1.0
- yiisoft/files: ^2.0
- yiisoft/html: ^3.0
- yiisoft/http: ^1.2
- yiisoft/i18n: ^1.1
- yiisoft/log: ^2.1
- yiisoft/log-target-file: ^3.0
- yiisoft/router: ^3.0
- yiisoft/router-fastroute: ^3.0
- yiisoft/translator: ^3.0
- yiisoft/translator-message-php: ^1.1
- yiisoft/view: ^10.0
- yiisoft/yii-console: ^2.0
- yiisoft/yii-debug: dev-master|dev-php80
- yiisoft/yii-event: ^2.0
- yiisoft/yii-http: ^1.0
- yiisoft/yii-middleware: ^1.0
- yiisoft/yii-runner-console: ^2.0
- yiisoft/yii-runner-http: ^2.0
- yiisoft/yii-view-renderer: ^7.1
Requires (Dev)
- codeception/c3: ^2.7
- codeception/codeception: ^5.0
- codeception/module-asserts: ^3.0
- codeception/module-cli: ^2.0
- codeception/module-phpbrowser: ^3.0
- maglnet/composer-require-checker: ^4.5
- phpunit/phpunit: ^9.5
- rector/rector: ^2.0.3
- roave/infection-static-analysis-plugin: ^1.34
- roave/security-advisories: dev-master
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^5.20
- yiisoft/yii-debug-api: 3.0.x-dev
- yiisoft/yii-debug-viewer: ^3.0@dev
- yiisoft/yii-gii: dev-master
- yiisoft/yii-testing: dev-master
This package is auto-updated.
Last update: 2024-12-13 09:54:23 UTC
README
Yii Application Template
Application template for Yii 3 is best for rapidly creating projects
Web application template for Yii 3.
Requirements
- PHP 8.1 or higher.
Local installation
If you do not have Composer, you may install it by following the instructions at getcomposer.org.
Create a project:
composer create-project --stability=dev yiisoft/app myproject
cd myproject
To run the app:
./yii serve
Now you should be able to access the application through the URL printed to console.
Usually it is http://localhost:8080
.
Installation with Docker
Fork the repository, clone it, then:
cd myproject
make composer update
To run the app:
make up
To stop the app:
make down
The application is available at https://localhost
.
Directory structure
The application template has the following structure:
config/ Configuration files.
docker/ Docker-specific files.
docs/ Documentation.
public/ Files publically accessible from the Internet.
assets/ Published assets.
index.php Entry script.
resources/ Application resources.
assets/ Asset bundle resources.
layout/ Layout view templates.
messages/
views/ View templates.
runtime/ Files generated during runtime.
src/ Application source code.
Asset/ Asset bundle definitions.
Command/ Console commands.
Controller/ Web controller classes.
EventHandler/
Handler/
ViewInjection/
tests/ A set of Codeception tests for the application.
vendor/ Installed Composer packages.
Makefile Config for make command.
Configuration
You can find configuration in config
directory. There are multiple configs,
and the most interesting is common\params.php
. Below there are details about its sections:
Application Services
There are multiple pre-configured application services.
Aliases
'yiisoft/aliases' => [ 'aliases' => [ // standard directory aliases '@root' => dirname(__DIR__), '@assets' => '@root/public/assets', '@assetsUrl' => '/assets', '@npm' => '@root/node_modules', '@public' => '@root/public', '@resources' => '@root/resources', '@runtime' => '@root/runtime', '@views' => '@root/resources/views' ], ],
See "Aliases" in the guide.
Cache
'yiisoft/cache-file' => [ 'file-cache' => [ // cache directory path 'path' => '@runtime/cache' ], ],
Log Target File
use Psr\Log\LogLevel; 'yiisoft/log-target-file' => [ 'file-target' => [ // route directory file log 'file' => '@runtime/logs/app.log', // levels logs target 'levels' => [ LogLevel::EMERGENCY, LogLevel::ERROR, LogLevel::WARNING, LogLevel::INFO, LogLevel::DEBUG, ], ], 'file-rotator' => [ // maximum file size, in kilobytes. Defaults to 10240, meaning 10MB. 'maxfilesize' => 10, // number of files used for rotation. Defaults to 5. 'maxfiles' => 5, // the permission to be set for newly created files. 'filemode' => null, // Whether to rotate files by copy and truncate in contrast to rotation by renaming files. 'rotatebycopy' => null ], ],
See "Logging" in the guide.
Session
'yiisoft/session' => [ 'session' => [ // options for cookies 'options' => ['cookie_secure' => 0], // session handler 'handler' => null ], ],
View
'yiisoft/view' => [ // Custom parameters that are shared among view templates. 'defaultParameters' => [ 'applicationParameters' => 'App\ApplicationParameters', 'assetManager' => 'Yiisoft\Assets\AssetManager', ], 'theme' => [ // Apply pathMap example: ['@resources/layout' => '@resources/theme'] in yiisoft/app // Apply pathMap example: ['@resources/layout' => '@modulealiases/theme'] in module 'pathMap' => [], 'basePath' => '', 'baseUrl' => '', ], ],
Yii Debug
'yiisoft/yii-debug' => [ // enabled/disabled debugger 'enabled' => true ],
Application Layout Parameters
'app' => [ 'charset' => 'UTF-8', 'language' => 'en', 'name' => 'My Project', ],
Testing
The template comes with ready to use Codeception configuration. To execute tests, in local installation run:
./vendor/bin/codecept build ./yii serve > ./runtime/yii.log 2>&1 & ./vendor/bin/codecept run
For Docker:
make codecept build make codecept run
Static analysis
The code is statically analyzed with Psalm. To run static analysis:
./vendor/bin/psalm
or, using Docker:
make psalm
Support
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The Yii application template is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.