# Jelix

[![License](https://poser.pugx.org/jelix/jelix/license)](https://packagist.org/packages/jelix/jelix)
[![Latest Stable Version](https://poser.pugx.org/jelix/jelix/v/stable)](https://packagist.org/packages/jelix/jelix)
[![Total Downloads](https://poser.pugx.org/jelix/jelix/downloads)](https://packagist.org/packages/jelix/jelix)
[![Latest Unstable Version](https://poser.pugx.org/jelix/jelix/v/unstable)](https://packagist.org/packages/jelix/jelix)

What is Jelix?
==============

Jelix is an open-source framework for PHP. Jelix 1.8 is compatible from PHP 7.4 to PHP 8.4.

It has a modular, 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](https://jelix.org/articles/en/features).

Installation
============

The best way is to use [Composer](https://getcomposer.org).
Create a directory and a composer.json file : 

```
{
    "name": "...",
    "require": {
        "php": ">=7.4",
        "jelix/jelix": "~1.8.19"
    }
}
```

**Warning**: Jelix does not follow yet [semantic versioning](https://semver.org). 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](https://jelix.org/articles/en/download).

Read [the documentation to create an application](https://docs.jelix.org/en/manual-1.8/installation/create-application).

Documentation and community
===========================

There is a full manual to learn Jelix. You can read it [direcly on the website](https://docs.jelix.org/en/manual-1.8).

You can ask your questions [on the forum](https://jelix.org/forums/forum/cat/2-english) or
on our IRC Channel, #jelix, on the libera.chat network.

Contribution & development
===========================

If you want to contribute, you can use the provided Docker stack which runs all 
what is needed to test Jelix, and launch unit tests. See the testapp/README.md 
file in the repository.

Fill issues on Github https://github.com/jelix/jelix/.
