{"id":28622951,"url":"https://github.com/phplucidframe/phplucidframe","last_synced_at":"2025-12-16T17:56:47.831Z","repository":{"id":57040582,"uuid":"21262061","full_name":"phplucidframe/phplucidframe","owner":"phplucidframe","description":"The simple, lightweight and yet powerful PHP framework","archived":false,"fork":false,"pushed_at":"2025-07-27T15:51:52.000Z","size":3330,"stargazers_count":24,"open_issues_count":0,"forks_count":15,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-27T17:46:27.971Z","etag":null,"topics":["framework","mysql","php","php-framework","phplucidframe"],"latest_commit_sha":null,"homepage":"http://www.phplucidframe.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phplucidframe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-06-27T02:52:05.000Z","updated_at":"2025-07-27T15:51:57.000Z","dependencies_parsed_at":"2024-03-04T17:48:56.797Z","dependency_job_id":"78f3b683-22f6-4c7d-bafa-193bbafd1dac","html_url":"https://github.com/phplucidframe/phplucidframe","commit_stats":{"total_commits":876,"total_committers":2,"mean_commits":438.0,"dds":"0.0011415525114155667","last_synced_commit":"c83989899e2eeac3b4464c1f4b7925c41ce71375"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"purl":"pkg:github/phplucidframe/phplucidframe","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phplucidframe%2Fphplucidframe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phplucidframe%2Fphplucidframe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phplucidframe%2Fphplucidframe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phplucidframe%2Fphplucidframe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phplucidframe","download_url":"https://codeload.github.com/phplucidframe/phplucidframe/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phplucidframe%2Fphplucidframe/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27769066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-16T02:00:10.477Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framework","mysql","php","php-framework","phplucidframe"],"created_at":"2025-06-12T06:13:52.567Z","updated_at":"2025-12-16T17:56:47.824Z","avatar_url":"https://github.com/phplucidframe.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# What is PHPLucidFrame?\n\nPHPLucidFrame (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.\n\nAlmost zero configuration - just configure your database setting and you are ready to go. No complex JSON, XML, YAML or vHost configuration.\n\nNo template engine to eliminate overhead of template processing and to save your storage from template cache files.\n\nIt supports a wide range of web application development features:\n\n- Database access API\n- Security control\n- URL routing\n- Validation helpers\n- Internationalization \u0026 Localization\n- User authentication \u0026 authorization API\n- Schema Manager\n- Database Seeding\n- Query Builder\n- Shell \u0026 Console Tool\n- Ajax\n\n\u003ctable\u003e\n    \u003cbody\u003e\n        \u003ctr\u003e\n            \u003ctd\u003e\u003cimg src=\"https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png\" width=\"50\" alt=\"JetBrains Logo\"\u003e\u003c/td\u003e\n            \u003ctd\u003eA big thank you to \u003ca href=\"https://www.jetbrains.com\"\u003eJetBrains\u003c/a\u003e for supporting this project with free open-source licences of their IDEs.\u003c/td\u003e\n        \u003c/tr\u003e\n    \u003c/body\u003e\n\u003c/table\u003e\n\n## Prerequisites\n\n- Web Server (Apache with `mod_rewrite` enabled)\n- PHP version 7.1 or newer is recommended, but we strongly advise you to use one of the currently supported versions.\n- MySQL 5.0 or newer\n\n## Installation\n\n- 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.\n- Rename it as **phplucidframe**.\n- 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).\n- Check `http://localhost/phplucidframe` in your browser.\n\n**Note:**\n- 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.\n- 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`.\n\n## Alternate Installation with Composer\n\nYou can install PHPLucidFrame alternatively using [Composer](http://getcomposer.org). Open your terminal and CD to your webserver document root, and then run\n\n    composer create-project --prefer-dist phplucidframe/phplucidframe [your-project-name]\n\n**Note:** You have to change the value of baseURL in `/inc/parameter/development.php` according to `[your-project-name]`.\n\n## Furthermore on Installation\n\n**Based URL** : There are two situations you will have to leave the configuration `baseURL` empty in `/inc/parameter/xxx.php` files:\n\n1. when you have a virtual host for your application in your development environment.\n2. when your application in production environment where you upload the framework files directly to your web server document root.\n\n**Routing** : You can define custom routes in `/inc/route.config.php`. The following routing for home page maps to `/app/home/index.php`.\n\n    route('lc_home')-\u003emap('/', '/home');\n\nPHPLucidFrame 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.\n\n**Additional Site Settings** : You can also configure the other settings in `/inc/config.php` and `/app/inc/site.config.php` according to your requirement.\n\n**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 `\u003c?php _css('yourfilename.css'); ?\u003e`. Then you can override the rules of `/assets/css/base.css` in your CSS file.\n\n## Documentation\n\n- [PDF Documentation](http://www.phplucidframe.com/download/doc/latest/pdf) - The complete PDF documentation is available to download.\n- [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).\n- [Code Samples](https://github.com/phplucidframe/phplucidframe/releases/latest) - The quick reference and coding samples are also available in the release.\n- [Sample Administration Module](https://github.com/phplucidframe/phplucidframe/wiki/Configuration-for-The-Sample-Administration-Module) - The configuration guideline for sample administration module.\n\n## Support \u0026 Resources\n\n- [Stackoverflow](http://stackoverflow.com/questions/tagged/phplucidframe)\n- [GitHub issues](https://github.com/phplucidframe/phplucidframe/issues)\n\n## Run Tests\n\nPrerequisites:\n\n    composer install\n\n    php lucidframe env test\n\nCreate 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`.\n\n    php lucidframe schema:load sample\n\nFrom **Command Line**,\n\n    # to run all tests\n    php tests/tests.php\n\n    # to run tests/lib/db_helper.test.php only\n    php tests/tests.php --file=db_helper\n\n    # to run tests/lib/validation_helper.test.php only\n    php tests/tests.php -f=validation_helper\n    # or\n    php tests/tests.php -f validation_helper\n\n    # to run tests/lib/db_helper.test.php and query_builer.test.php\n    php tests/tests.php --file=db_helper,query_builder\n\nNote: You can also use the short-form option name `f` instead of `file`.\n\nFrom **Browser**,\n\n    # to run all tests\n    http://[site_url]/tests/tests.php\n\n    # to run tests/lib/db_helper.test.php only\n    http://[site_url]/tests/tests.php?file=db_helper\n\n    # to run tests/lib/db_helper.test.php and query_builer.test.php\n    http://[site_url]/tests/tests.php?file=db_helper,query_builder\n\nNote: You can also use the query string parameter `f` instead of `file`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphplucidframe%2Fphplucidframe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphplucidframe%2Fphplucidframe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphplucidframe%2Fphplucidframe/lists"}