Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 2.57 KB

README.md

File metadata and controls

75 lines (53 loc) · 2.57 KB

Jelix

Build Status License Latest Stable Version Total Downloads Latest Unstable Version

What is Jelix?

Jelix 2 is an open-source framework for PHP 7.0+.

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 informations, 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 (even if we try to no do it) 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.6.x branch. For the next stable release, see the jelix-1.7.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 5.6 or more.

For applications with the future Jelix 2.0, you should use Composer. You should declare the jelix package dependency in your composer.json:

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

Then you run:

php composer.phar install

Then read the documentation to create an application.

Documentation and community

The documentation is not updated yet with all changes since the release of Jelix 1.7.x. But it should be ok for most of things.

You can ask your questions on the forum or on our IRC Channel, #jelix, on the irc.freenode.net network.

Contribution & development

see CONTRIBUTING.md.