Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 3.77 KB

README.md

File metadata and controls

59 lines (37 loc) · 3.77 KB
Raw

Simple MVC Framework

Version 2.2

Software License Total Downloads Dependency Status GitHub license GitHub stars GitHub forks

Join the chat at https://gitter.im/simple-mvc-framework/framework

What is Simple MVC Framework?

Simple MVC Framework is a PHP 5.5 MVC system. It's designed to be lightweight and modular, allowing developers to build better and easy to maintain code with PHP.

The base framework comes with a range of helper classes.

Packagist

The framework is now on packagist https://packagist.org/packages/simple-mvc-framework/v2.

Install from terminal now by using:

composer create-project simple-mvc-framework/v2 foldername -s dev

The foldername is the desired folder to be created.

Documentation

Full docs & tutorials are available at simplemvcframework.com.

Requirements

The framework requirements are limited:

Although a database is not required, if a database is to be used the system is designed to work with a MySQL database. The framework can be changed to work with another database type.

Installation

  1. Download the framework.
  2. Unzip the package.
  3. To run composer, navigate to your project on a terminal/command prompt, then run composer install. That will update the vendor folder. Or use the vendor folder as is (composer is not required for this step). Upload the framework files to your server. Normally the index.php file will be at your root.
  4. Open the app/Core/routes.php file with a text editor and setup your routes.
  5. Open app/Core/Config.example.php and set your base path (if the framework is installed in a folder, the base path should reflect the folder path /path/to/folder/ otherwise a single / will do) and database credentials (if a database is needed). Set the default theme. When you are done, rename the file to Core/Config.php.
  6. Edit .htaccess file and save the base path (if the framework is installed in a folder, the base path should reflect the folder path /path/to/folder/ otherwise a single / will do).

Other Contributions

Have you found this framework helpful? Why not take a minute to endorse my hard work on coderwall! Just click the badge below:

endorse