<commit_before># What is LucidFrame?

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cithukyaw/LucidFrame?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

PHPLucidFrame (a.k.a LucidFrame) is a mini application development framework - a toolkit 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. LucidFrame 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.

Although it is stated as mini framework, it supports a wide range of web application development features:

- Datatase access API
- Security control
- URL routing
- Validation helpers
- Internationalization & Localization
- User authentication & authorization API
- Ajax

## Prerequisites

- Web Server (Apache with `mod_rewrite` enabled)
- PHP version 5.2.0 or newer (optional `mcrypt` extension enabled, but recommended)
- MySQL 5.0 or newer with MySQLi enabled.

## Installation

- Extract [the downloaded archive](https://github.com/cithukyaw/LucidFrame/releases/latest) in your local webserver document root, and you will get a folder named **LucidFrame-x.y.z** where **x.y.z** would be your downloaded version.
- Rename it as **LucidFrame** or your project name.
- Copy `/inc/config.default.php` and rename it to `/inc/config.php`
- Copy `/inc/site.config.default.php` and rename it to `/inc/site.config.php`.
- (Optional, but recommended) Copy `/inc/tpl/head.php` to `/app/inc/tpl/head.php` if you want to update it.
- Check `http://localhost/LucidFrame` or `http://localhost/YourProjectName` in your browser.

**Note:** If you have your own project folder name other than **LucidFrame**, you should change `$lc_baseURL` in `/inc/config.php` in accordance with your project name.

## Using Composer

You can also install LucidFrame using [Composer](http://getcomposer.org/).

    composer require lucidframe/phplucidframe:~1.5.0

OR

    php composer.phar require lucidframe/phplucidframe:~1.5.0

## Furthermore on Installation

**URL Rewrite** : Make sure you have `mod_rewrite` activated on your server / in your environment.
Some guidelines:

- [XAMPP for Windows](http://www.leonardaustin.com/blog/technical/enable-mod_rewrite-in-xampp/)
- [Ubuntu 14.04 LTS](http://www.dev-metal.com/enable-mod_rewrite-ubuntu-14-04-lts/)
- [Ubuntu 12.04 LTS](http://www.dev-metal.com/enable-mod_rewrite-ubuntu-12-04-lts/)
- [EasyPHP on Windows](http://stackoverflow.com/questions/8158770/easyphp-and-htaccess)
- [AMPPS on Windows/Mac OS](http://www.softaculous.com/board/index.php?tid=3634&title=AMPPS_rewrite_enable/disable_option%3F_please%3F)
- [MAMP on Mac OS](http://stackoverflow.com/questions/7670561/how-to-get-htaccess-to-work-on-mamp)
<commit_msg>Removed composer information from README.md temporarily<commit_after># What is LucidFrame?

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cithukyaw/LucidFrame?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

PHPLucidFrame (a.k.a LucidFrame) is a mini application development framework - a toolkit 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. LucidFrame 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.

Although it is stated as mini framework, it supports a wide range of web application development features:

- Datatase access API
- Security control
- URL routing
- Validation helpers
- Internationalization & Localization
- User authentication & authorization API
- Ajax

## Prerequisites

- Web Server (Apache with `mod_rewrite` enabled)
- PHP version 5.2.0 or newer (optional `mcrypt` extension enabled, but recommended)
- MySQL 5.0 or newer with MySQLi enabled.

## Installation

- Extract [the downloaded archive](https://github.com/cithukyaw/LucidFrame/releases/latest) in your local webserver document root, and you will get a folder named **LucidFrame-x.y.z** where **x.y.z** would be your downloaded version.
- Rename it as **LucidFrame** or your project name.
- Copy `/inc/config.default.php` and rename it to `/inc/config.php`
- Copy `/inc/site.config.default.php` and rename it to `/inc/site.config.php`.
- (Optional, but recommended) Copy `/inc/tpl/head.php` to `/app/inc/tpl/head.php` if you want to update it.
- Check `http://localhost/LucidFrame` or `http://localhost/YourProjectName` in your browser.

**Note:** If you have your own project folder name other than **LucidFrame**, you should change `$lc_baseURL` in `/inc/config.php` in accordance with your project name.

## Furthermore on Installation

**URL Rewrite** : Make sure you have `mod_rewrite` activated on your server / in your environment.
Some guidelines:

- [XAMPP for Windows](http://www.leonardaustin.com/blog/technical/enable-mod_rewrite-in-xampp/)
- [Ubuntu 14.04 LTS](http://www.dev-metal.com/enable-mod_rewrite-ubuntu-14-04-lts/)
- [Ubuntu 12.04 LTS](http://www.dev-metal.com/enable-mod_rewrite-ubuntu-12-04-lts/)
- [EasyPHP on Windows](http://stackoverflow.com/questions/8158770/easyphp-and-htaccess)
- [AMPPS on Windows/Mac OS](http://www.softaculous.com/board/index.php?tid=3634&title=AMPPS_rewrite_enable/disable_option%3F_please%3F)
- [MAMP on Mac OS](http://stackoverflow.com/questions/7670561/how-to-get-htaccess-to-work-on-mamp)

{'fraction_non_alphanumeric': 0.10971579643093192, 'fraction_numerical': 0.01520158625247852, 'mean_word_length': 4.72117202268431, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 8, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '155146', 'n_tokens_mistral': 1959, 'n_tokens_neox': 1824, 'n_words': 598}