mirror of
https://github.com/yiisoft/yii2.git
synced 2025-08-14 22:30:27 +08:00
100 lines
4.6 KiB
Markdown
100 lines
4.6 KiB
Markdown
<p align="center">
|
|
<a href="https://www.yiiframework.com/" target="_blank">
|
|
<img src="https://www.yiiframework.com/image/yii_logo_light.svg" width="400" alt="Yii Framework" />
|
|
</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.
|
|
|
|
[](https://packagist.org/packages/yiisoft/yii2)
|
|
[](https://packagist.org/packages/yiisoft/yii2)
|
|
[](https://github.com/yiisoft/yii2/actions)
|
|
[](https://scrutinizer-ci.com/g/yiisoft/yii2/)
|
|
[](https://scrutinizer-ci.com/g/yiisoft/yii2/)
|
|
|
|
Installation
|
|
------------
|
|
|
|
- The minimum required PHP version of Yii is PHP 5.4.
|
|
- It works best with PHP 8.
|
|
- [Follow the Definitive Guide](https://www.yiiframework.com/doc-2.0/guide-start-installation.html)
|
|
in order to get step by step instructions.
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
- A [Definitive Guide](https://www.yiiframework.com/doc/guide/2.0) and
|
|
a [Class Reference](https://www.yiiframework.com/doc/api/2.0) cover every detail
|
|
of the framework.
|
|
- There is a [PDF version](https://www.yiiframework.com/doc/download/yii-guide-2.0-en.pdf) of the Definitive Guide
|
|
and a [Definitive Guide Mirror](http://stuff.cebe.cc/yii2docs/) which is updated every 15 minutes.
|
|
- For Yii 1.1 users, there is [Upgrading from Yii 1.1](https://www.yiiframework.com/doc/guide/2.0/en/intro-upgrade-from-v1)
|
|
to get an idea of what has changed in 2.0.
|
|
|
|
Community
|
|
---------
|
|
|
|
- Participate in [discussions at forums](https://www.yiiframework.com/forum/).
|
|
- [Community Slack](https://join.slack.com/t/yii/shared_invite/MjIxMjMxMTk5MTU1LTE1MDE3MDAwMzMtM2VkMTMyMjY1Ng) and [Chat in IRC](https://www.yiiframework.com/chat/).
|
|
- Follow us on [Facebook](https://www.facebook.com/groups/yiitalk/), [Twitter](https://twitter.com/yiiframework)
|
|
and [GitHub](https://github.com/yiisoft/yii2).
|
|
- Check [other communities](https://github.com/yiisoft/yii2/wiki/communities).
|
|
|
|
Contributing
|
|
------------
|
|
|
|
The framework is [Open Source](LICENSE.md) powered by [an excellent community](https://github.com/yiisoft/yii2/graphs/contributors).
|
|
|
|
You may join us and:
|
|
|
|
- [Report an issue](docs/internals/report-an-issue.md)
|
|
- [Translate documentation or messages](docs/internals/translation-workflow.md)
|
|
- [Give us feedback or start a design discussion](https://www.yiiframework.com/forum/index.php/forum/42-general-discussions-for-yii-20/)
|
|
- [Contribute to the core code or fix bugs](docs/internals/git-workflow.md)
|
|
- [Become a sponsor](#sponsoring)
|
|
|
|
### Reporting Security issues
|
|
|
|
Please refer to a [special page at the website](https://www.yiiframework.com/security/)
|
|
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](https://www.yiiframework.com/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](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat) in your README:
|
|
|
|
|
|
|
|
If your code is hosted at GitHub, you can place the following in your README.md file to get the badge:
|
|
|
|
```
|
|
[](https://www.yiiframework.com/)
|
|
```
|
|
|
|
### Sponsoring
|
|
|
|
Support this project by becoming a sponsor or a backer.
|
|
|
|
[](https://opencollective.com/yiisoft) [](https://opencollective.com/yiisoft)
|