Repository: yiisoft/yii2

Stars: 14312

README.md Copy Chapter

<p align="center">
<a href="https://www.yiiframework.com/" target="_blank">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://www.yiiframework.com/image/design/logo/yii3_full_for_dark.svg">
<source media="(prefers-color-scheme: light)" srcset="https://www.yiiframework.com/image/design/logo/yii3_full_for_light.svg">
<img src="https://www.yiiframework.com/image/design/logo/yii3_full_for_light.svg" alt="Yii Framework" height="100">
</picture>
</a>
</p>

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.


Installation
------------

- It works best with PHP 8.

- Follow the Definitive Guide
in order to get step by step instructions.

Documentation
-------------

- A Definitive Guide and
a Class Reference cover every detail
of the framework.
- There is a PDF version of the Definitive Guide
and a Definitive Guide Mirror which is updated every 15 minutes.
- For Yii 1.1 users, there is Upgrading from Yii 1.1
to get an idea of what has changed in 2.0.

Versions & PHP compatibility
----------------------------

Community
---------

- Participate in discussions at forums.
- Community Slack and Chat in IRC.
- Follow us on Facebook, Twitter
and GitHub.
- Check other communities.

Contributing
------------

The framework is Open Source powered by an excellent community.

You may join us and:

- Report an issue
- Translate documentation or messages
- Give us feedback or start a design discussion
- Contribute to the core code or fix bugs
- Become a sponsor

Reporting Security issues Copy Section

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

Directory Structure Copy Section

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

Spreading the Word Copy Section

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:


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

![Yii2](https://www.yiiframework.com/)

Sponsoring Copy Section

Support this project by becoming a sponsor or a backer.