Documentation/Introduction

Introduction

HLEB2 is the second version of the HLEB framework, completely revamped and improved.

It supports PHP version 8.2 and above, but if you want to use earlier versions of PHP, you can try the first version of the framework.

The initial version 2.0.0 of the framework was released in February 2024.
The new version has introduced support for asynchronous execution, allowing the framework to be used with technologies such as RoadRunner and Swoole.
Significant focus has been placed on performance and maintainability, implementing compatibility with PSR, adding a service container along with Dependency Injection, and much more.

It adheres to the recommendations of PSR-1, PSR-2, PSR-3, PSR-4, PSR-7, PSR-11, PSR-12, and PSR-16 without mandatory implementation in development.


#Purpose

This framework can serve as a foundation for small projects, such as: a separate admin panel, microservice, chatbot, experimental pet project, console processor; as well as medium-sized websites, and can also lay the groundwork for developing your own framework with extended capabilities. In the latter case, it can also be used for large enterprise websites.

HLEB2 is positioned as a simple and fast framework that efficiently performs its job.

A key feature of the HLEB framework (and also HLEB2) is a complete abandonment of third-party libraries in the basic setup; at the same time, there is the possibility to integrate third-party libraries if necessary.
Thus, further actions are not predetermined by dependencies, ensuring necessary flexibility.

To use the framework, at minimum, one must have basic programming knowledge of the PHP language.

The framework is a multi-purpose tool, and every tool can be used for unintended purposes, so it is assumed that the application developer understands what they are doing and can choose the appropriate approach for their specific project.

The framework's code is thoroughly tested with unit tests.


#Projects Based on the Framework

Among the applications known to the author based on HLEB2 is the discussion (and Q&A) engine LibArea. Project on GitHub: github.com/LibArea/libarea
It is assumed that projects based on LibArea also operate on the HLEB2 framework.


#How to Use the Documentation

The detailed guide to the framework consists of various sections. Some of the information is accompanied by code examples, such as (routing declaration):

Route::get('/'view('default'))->name('homepage');

The list of documentation sections is located in the site's menu.
For beginners, it's recommended to start exploring the framework with topics on installation, routing, and configuration editing.

Information that requires special attention will be highlighted in such a block.

A warning that should not be ignored will be highlighted in this kind of block.


#Local Installation of Documentation

This documentation can be installed and used offline. The code is located in an open repository, and after local installation, you simply need to keep track of updates.

Framework Installation

Page translated: chatgpt 4-o
Back to top