yii2 README

The project's README from github.com/yiisoft/yii2. As one markdown file: README.md.

Yii Framework

Yii 2 is a modern framework designed to be a solid foundation for your PHP application.

It is fast, secure and efficient and works right out of the box pre-configured with reasonable defaults. The framework is easy to adjust to meet your needs, because Yii has been designed to be flexible.

Latest Stable Version Total Downloads Build Status Static Analysis codecov

Installation

[!IMPORTANT]

  • The minimum required PHP version of Yii is PHP 7.4.
  • It works best with PHP 8.

Documentation

Versions & PHP compatibility

[!NOTE] See "Release Cycle" at the website for detailed information about supported versions.

Community

Contributing

The framework is Open Source powered by an excellent community.

You may join us and:

Reporting Security issues

[!WARNING] Please do not report security vulnerabilities through public GitHub issues.

Please refer to a special page at the website describing proper workflow for security issue reports.

Directory Structure

build/               internally used build tools
docs/                documentation
framework/           core framework code
tests/               tests of the core framework code

Spreading the Word

Acknowledging or citing Yii 2 is as important as direct contributions.

In presentations

If you are giving a presentation or talk featuring work that makes use of Yii 2 and would like to acknowledge it, we suggest using our logo on your title slide.

In projects

If you are using Yii 2 as part of an OpenSource project, a way to acknowledge it is to use a special badge in your README:

Yii2

If your code is hosted at GitHub, you can place the following in your README.md file to get the badge:

[![Yii2](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=for-the-badge&logo=yii)](https://www.yiiframework.com/)

Sponsoring

Support this project by becoming a sponsor or a backer.

Open Collective sponsors Open Collective backers

yii2 (yiisoft/yii2)

Searching Database…

14.3K ·GitHub
What is this?Yii 2 is a modern, open source PHP framework for building web applications, meant to be a solid, fast and secure foundation that works right out of the box with sensible defaults.
Is this a full framework or just a component library?It is a full MVC framework meant to be the backbone of your whole PHP application, not a standalone library, and it is designed to be adjusted and extended to fit your needs.
How do I get a Yii 2 project running?The repo itself has no quick-start command; it directs you to the Definitive Guide for step-by-step installation instructions.
What PHP version do I need?Yii 2 requires at least PHP 7.4, but it is recommended to run it on PHP 8 for best results.
Can I just drop my Yii 1.1 code into Yii 2?No, Yii 2 is a rewrite, not a drop-in replacement for Yii 1.1; the project provides a separate upgrade guide for migrating 1.1 apps.
Who is Yii 2 built for?It targets PHP developers who want a pre-configured, production-ready MVC foundation for web apps instead of wiring everything together themselves.
Does Yii 2 work with multiple databases?The project's CI pipeline runs separate workflows for MariaDB, MySQL and MSSQL, showing the framework is built and tested against several database backends.
Is there Docker support?The repository includes Docker configuration, though no docker-compose setup is bundled, so you still assemble your own multi-service stack.
Where do I find full documentation?Beyond the quick README, Yii ships a Definitive Guide and Class Reference, including a PDF version and a mirror that updates every 15 minutes.
Creator
yiisoft
Size
89.7 MB
Stars
14.3K
Age
14y
Commits · 90 Days