Installation

To install the framework you have 2 methods:

  • Clone the GitHub Repo:
    • git clone https://github.com/CallMeLeon167/CML-Framework.git new-project
cd new-project
rm -rf .git
  • Get it form Composer:
    • composer create-project callmeleon167/cml-framework new-project

Configuration

After installing the project, execute this code or just create an cml-config.php file:

cd new-project
cd app/config/
cp cml-config.template.php cml-config.php

Then open the cml-config.php file and set your database credentials and project settings.

Database Settings

Name Description
DB_NAME The name of the MySQL database.
DB_USER MySQL database username for authentication.
DB_PASSWORD MySQL database password for authentication.
DB_HOST MySQL hostname or IP address.
DB_CHARSET Character set for the MySQL database.

Project Settings

Name Description
PRODUCTION Set the development mode. When set to true, the application is in production mode; set to false for development. This will toggle the error reporting
CML_DEBUG Custom enhanced error display for better debugging.
CML_DEBUG_BAR Custom debug bar for better debugging.
ERRORLOG_FILE Define the path to the log file.
APP_NAME The name of the application.

There are other project settings, but you can leave them as they are.

Directory Structure