phalcon/cphalcon

Phalcon Framework

Phalcon is an open-source web framework delivered as a C extension for PHP, 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

Using PIE (recommended)

PIE is the modern PHP extension installer:

pie install phalcon/cphalcon

Using PECL

[!IMPORTANT] PECL has been deprecated, so users should switch to installing Phalcon with PIE. We will keep releasing on PECL until PECL is retired or v5.x reaches its end of life.

pecl install phalcon

From source

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 bin/generate-api-docs.php. Steps:

• Clone the phalcon repo
• Checkout the tag you would like to generate docs for.
• Run php bin/generate-api-docs.php
• The generated *.md files 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 in
• Incubator - community-driven plugins and classes that extend the framework (written in PHP)

Support

• Discussions
• 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]

Backers

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

License

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

Copyright © 2011-present, Phalcon Team.

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