Phalcon Framework

![Phalcon Backers][backers-badge] ![OpenCollective][oc-backers-badge] ![OpenCollective][oc-sponsors-badge]

![5.0 Pull Requests][phalcon-5x-pr-badge] ![5.0 Issues][phalcon-5x-issue-badge]

Phalcon is an open source web framework delivered as a C extension for the PHP language providing high performance and lower resource consumption.

A big thank you to our Backers; you rock!

Getting Started

Phalcon is written in Zephir/C with platform independence in mind. As a result, Phalcon is available on Microsoft Windows, GNU/Linux, FreeBSD and macOS. You can either download a binary package for the system of your choice or build it from source.

Installation

For detailed installation instructions you can check our installation page in the docs.

Generating API Documentation

Generating new documentation files for docs repository can be done using the script in tests/__config/generate-api-docs.php. Steps:

• Clone the phalcon repo
• Checkout the tag you would like to generate docs for.
• Run php tests/__config/generate-api-docs.php
• The files *.md files in nikos/api/ will contain the documentation
• For publishing to the Phalcon website this repo is used.

Links

General

• Contributing to Phalcon
• Official Documentation
• Zephir - The language Phalcon is written on
• Incubator - Community driven plugins and classes extending the framework (written in PHP)

Support

• Forum
• Discord
• Stack Overflow

Social Media

• Telegram
• Gab
• LinkedIn
• MeWe
• Facebook
• Twitter

Sponsors

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

<a href="https://opencollective.com/phalcon/#contributors"> <img src="https://opencollective.com/phalcon/tiers/sponsors.svg?avatarHeight=48&width=800" alt="OpenCollective Contributors"> </a>

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

<a href="https://opencollective.com/phalcon/#contributors"> <img src="https://opencollective.com/phalcon/tiers/backers.svg?avatarHeight=48&width=800&height=200" alt="OpenCollective Contributors"> </a>

License

Phalcon is open source software licensed under the BSD 3-Clause License.

Copyright © 2011-present, Phalcon Team.

See the LICENSE.txt file for more. Additional licenses of packages that Phalcon uses, is inspired by or has adapted is located in the 3rdparty/licenses directory.

<!-- External links should be here -->

[backers-badge]: