PHPackages                             phplucidframe/phplucidframe - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. phplucidframe/phplucidframe

ActiveLibrary[Framework](/categories/framework)

phplucidframe/phplucidframe
===========================

The simple, lightweight & yet powerful PHP framework

v3.5.0(11mo ago)245715MITPHPPHP >=7.1

Since Jan 1Pushed 3mo ago4 watchersCompare

[ Source](https://github.com/phplucidframe/phplucidframe)[ Packagist](https://packagist.org/packages/phplucidframe/phplucidframe)[ Docs](http://www.phplucidframe.com)[ RSS](/packages/phplucidframe-phplucidframe/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (10)Dependencies (1)Versions (29)Used By (0)

What is PHPLucidFrame?
======================

[](#what-is-phplucidframe)

PHPLucidFrame (a.k.a. LucidFrame) is an application development framework for PHP developers. It provides logical structure and several helper utilities for web application development. It uses a functional architecture to simplify complex application development. It is especially designed for PHP, MySQL and Apache. It is simple, fast, lightweight and easy to install.

Almost zero configuration - just configure your database setting and you are ready to go. No complex JSON, XML, YAML or vHost configuration.

No template engine to eliminate overhead of template processing and to save your storage from template cache files.

It supports a wide range of web application development features:

- Database access API
- Security control
- URL routing
- Validation helpers
- Internationalization & Localization
- User authentication & authorization API
- Schema Manager
- Database Seeding
- Query Builder
- Shell & Console Tool
- Ajax
- Live Component

  [![JetBrains Logo](https://camo.githubusercontent.com/fb05ef5dfb873be566f687c659530467837038a1f1b3160accc9e8df636d323a/68747470733a2f2f7265736f75726365732e6a6574627261696e732e636f6d2f73746f726167652f70726f64756374732f636f6d70616e792f6272616e642f6c6f676f732f6a625f6265616d2e706e67)](https://camo.githubusercontent.com/fb05ef5dfb873be566f687c659530467837038a1f1b3160accc9e8df636d323a/68747470733a2f2f7265736f75726365732e6a6574627261696e732e636f6d2f73746f726167652f70726f64756374732f636f6d70616e792f6272616e642f6c6f676f732f6a625f6265616d2e706e67) A big thank you to [JetBrains](https://www.jetbrains.com) for supporting this project with free open-source licences of their IDEs.  Prerequisites
-------------

[](#prerequisites)

- Web Server (Apache with `mod_rewrite` enabled)
- PHP version 7.1 or newer is recommended, but we strongly advise you to use one of the currently supported versions.
- MySQL 5.0 or newer

Installation
------------

[](#installation)

- Extract [the downloaded archive](http://www.phplucidframe.com/download/release/latest) in your local webserver document root, and you will get a folder named **phplucidframe-x.y.z** where **x.y.z** would be your downloaded version.
- Rename it as **phplucidframe**.
- Open your terminal or command line and CD to your project root, and then run `php lucidframe secret:generate`. For more about the PHPLucidFrame console, read [the documentation section "The LucidFrame Console"](http://www.phplucidframe.com/download/doc/latest).
- Check `http://localhost/phplucidframe` in your browser.

**Note:**

- If you have your own project folder name other than `phplucidframe` in your development environment, you have to change the value of `baseURL` in `/inc/parameter/development.php` in accordance with your project name.
- If you use a virtual host for your project, you have to leave an empty string for the value of `baseURL` in `/inc/parameter/development.php`.

Alternate Installation with Composer
------------------------------------

[](#alternate-installation-with-composer)

You can install PHPLucidFrame alternatively using [Composer](http://getcomposer.org). Open your terminal and CD to your webserver document root, and then run

```
composer create-project --prefer-dist phplucidframe/phplucidframe [your-project-name]

```

**Note:** You have to change the value of baseURL in `/inc/parameter/development.php` according to `[your-project-name]`.

Furthermore on Installation
---------------------------

[](#furthermore-on-installation)

**Based URL** : There are two situations you will have to leave the configuration `baseURL` empty in `/inc/parameter/xxx.php` files:

1. when you have a virtual host for your application in your development environment.
2. when your application in production environment where you upload the framework files directly to your web server document root.

**Routing** : You can define custom routes in `/inc/route.config.php`. The following routing for home page maps to `/app/home/index.php`.

```
route('lc_home')->map('/', '/home');

```

PHPLucidFrame encourages a structured page organization. You can check the recommended structure in the sample page folders and codes `/app/home/` and `/app/example/` of the release.

**Additional Site Settings** : You can also configure the other settings in `/inc/config.php` and `/app/inc/site.config.php` according to your requirement.

**CSS Template** : PHPLucidFrame provides you a default site CSS template `/assets/css/base.css`. To make your site easily upgradable in the future, create your own file in `/app/assets/css` with whatever name you like and update your `/app/inc/tpl/layout.php` by including ``. Then you can override the rules of `/assets/css/base.css` in your CSS file.

Documentation
-------------

[](#documentation)

- [PDF Documentation](http://www.phplucidframe.com/download/doc/latest/pdf) - The complete PDF documentation is available to download.
- [API Documentation](http://www.phplucidframe.com#api) - API documentation of every version is available and generated by [ApiGen](http://apigen.org) and [phpDocumentor](http://phpdoc.org).
- [Code Samples](https://github.com/phplucidframe/phplucidframe/releases/latest) - The quick reference and coding samples are also available in the release.
- [Sample Administration Module](https://github.com/phplucidframe/phplucidframe/wiki/Configuration-for-The-Sample-Administration-Module) - The configuration guideline for sample administration module.

Support & Resources
-----------------------

[](#support--resources)

- [Stackoverflow](http://stackoverflow.com/questions/tagged/phplucidframe)
- [GitHub issues](https://github.com/phplucidframe/phplucidframe/issues)

Run Tests
---------

[](#run-tests)

Prerequisites:

```
composer install

php lucidframe env test

```

Create a test database and setup in `inc/parameter/test.php`. By default, the database name `lucid_blog_test` is set up under `sample` namespace. Then you can create a new database `lucid_blog_test` and run `schema:load sample`.

```
php lucidframe schema:load sample

```

From **Command Line**,

```
# to run all tests
php tests/tests.php

# to run tests/lib/db_helper.test.php only
php tests/tests.php --file=db_helper

# to run tests/lib/validation_helper.test.php only
php tests/tests.php -f=validation_helper
# or
php tests/tests.php -f validation_helper

# to run tests/lib/db_helper.test.php and query_builer.test.php
php tests/tests.php --file=db_helper,query_builder

```

Note: You can also use the short-form option name `f` instead of `file`.

From **Browser**,

```
# to run all tests
http://[site_url]/tests/tests.php

# to run tests/lib/db_helper.test.php only
http://[site_url]/tests/tests.php?file=db_helper

# to run tests/lib/db_helper.test.php and query_builer.test.php
http://[site_url]/tests/tests.php?file=db_helper,query_builder

```

Note: You can also use the query string parameter `f` instead of `file`.

###  Health Score

46

—

FairBetter than 92% of packages

Maintenance69

Regular maintenance activity

Popularity21

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~160 days

Recently: every ~330 days

Total

25

Last Release

336d ago

Major Versions

v1.19.0 → v2.0.02018-12-18

v2.2.0 → v3.0.02021-12-13

PHP version history (4 changes)v1.1.0-rcPHP >=5.2.0

v1.12.0PHP >=5.3.0

v3.0.0PHP >=5.6.0

v3.5.0PHP >=7.1

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/4285555?v=4)[Sithu](/maintainers/cithukyaw)[@cithukyaw](https://github.com/cithukyaw)

---

Top Contributors

[![cithukyaw](https://avatars.githubusercontent.com/u/4285555?v=4)](https://github.com/cithukyaw "cithukyaw (1093 commits)")

---

Tags

frameworkmysqlphpphp-frameworkphplucidframeframework

### Embed Badge

![Health badge](/badges/phplucidframe-phplucidframe/health.svg)

```
[![Health](https://phpackages.com/badges/phplucidframe-phplucidframe/health.svg)](https://phpackages.com/packages/phplucidframe-phplucidframe)
```

###  Alternatives

[hemp/presenter

Easy Model Presenters in Laravel

247608.3k1](/packages/hemp-presenter)[pestphp/pest-plugin-stressless

Stressless plugin for Pest

68943.9k18](/packages/pestphp-pest-plugin-stressless)[wpstarter/framework

The WpStarter Framework - Laravel Framework for WordPress

1610.2k5](/packages/wpstarter-framework)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)