Jelix

What is Jelix?

Jelix 2 is an open-source framework for PHP. Jelix 2 is compatible from PHP 8.1 to PHP 8.4.

It has a modular and extensible architecture. Applications based on Jelix are made with modules, which allow to reuse features in several projects.

For more information, read details about its features.

About stable versions and branches

WARNING: many changes occurs in the master branch, because of a "namespacification" which is not finished yet. So API may change or may be broken. Don't use it for production for the moment! However if you want to migrate an existing application to this unstable Jelix version ( just for tests! ), read the file [UPGRADE-TO-2.0.md].

The master branch will be Jelix 2.0.

For the current stable release, see the jelix-1.8.x branch. For the next stable release, see the jelix-1.9.x branch.

Please, to fix issues on stable versions, do it on their corresponding branches, not master! So do pull requests on stable branches!

Installation

The source code of the master branch (Jelix 2.0) is compatible only with PHP 8.1 or more.

The best way is to use Composer. Create a directory and a composer.json file :

{
    "name": "...",
    "require": {
        "php": ">=8.1",
        "jelix/jelix": "dev-master"
    }
}

Warning: Jelix does not follow yet semantic versioning. Minor versions (1.8, 1.9, 1.10 etc) may have some tiny breaking changes. So you must not use the ^ version constraint (ex: use ~1.8.19 instead of ^1.8.19 ).

Then you run:

composer install

Instead of using Composer, you can also download directly a package containing Jelix ready to use. See the download page.

Read the documentation to create an application.

Documentation and community

There is a full manual to learn Jelix. You can read it direcly on the website.

You can ask your questions on the forum or on our IRC Channel, #jelix, on the libera.chat network.

Contribution & development

see CONTRIBUTING.md.